initial setup

.gitignore

@@ -0,0 +1,140 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Pickle files
+*.pkl
+
+# Various files
+ignored
+debug
+*.zip
+lc0
+!bin/lc0
+wandb
+**/.DS_Store
+
+*secret*

README.md

@@ -1,12 +1,14 @@
 ---
 title: Lczerolens Backends Demo
-emoji: 📚
+emoji: 🔬
 colorFrom: gray
-colorTo: red
+colorTo: green
 sdk: gradio
 sdk_version: 5.28.0
 app_file: app.py
-pinned: false
+pinned: true
+license: mit
+short_description: Demo lczerolens backends features.
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+See the documentation [here](https://lczerolens.readthedocs.io/).

app.py

@@ -0,0 +1,24 @@
+"""
+Gradio demo for lczerolens backends.
+"""
+
+import gradio as gr
+
+from demo.interfaces import convert
+
+demo = gr.TabbedInterface(
+    [
+        convert.interface,
+    ],
+    [
+        "Convert",
+    ],
+    title="Lczero Backends Demo",
+    analytics_enabled=False,
+)
+
+if __name__ == "__main__":
+    demo.launch(
+        server_port=8000,
+        server_name="0.0.0.0",
+    )

demo/constants.py

@@ -0,0 +1,18 @@
+"""
+Constants for the demo.
+"""
+
+import os
+
+ONNX_MODEL_DIRECTORY = "demo/onnx-models"
+LEELA_MODEL_DIRECTORY = "demo/leela-models"
+FIGURE_DIRECTORY = "demo/figures"
+
+ONNX_MODEL_NAMES = [
+    f for f in os.listdir(ONNX_MODEL_DIRECTORY)
+    if f.endswith(".onnx")
+]
+LEELA_MODEL_NAMES = [
+    f for f in os.listdir(LEELA_MODEL_DIRECTORY)
+    if f.endswith(".pb.gz")
+]

demo/figures/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

demo/interfaces/convert.py

@@ -0,0 +1,281 @@
+"""
+Gradio interface for converting models.
+"""
+
+import os
+import uuid
+import re
+import subprocess
+
+import gradio as gr
+
+from demo import constants, utils
+from lczerolens import backends
+
+def get_models_info(onnx=True, leela=True):
+    """
+    Get the names of the models in the model directory.
+    """
+    model_df = []
+    exp = r"(?P<n_filters>\d+)x(?P<n_blocks>\d+)"
+    if onnx:
+        for filename in os.listdir(constants.MODEL_DIRECTORY):
+            if filename.endswith(".onnx"):
+                match = re.search(exp, filename)
+                if match is None:
+                    n_filters = -1
+                    n_blocks = -1
+                else:
+                    n_filters = int(match.group("n_filters"))
+                    n_blocks = int(match.group("n_blocks"))
+                model_df.append(
+                    [
+                        filename,
+                        "ONNX",
+                        n_blocks,
+                        n_filters,
+                    ]
+                )
+    if leela:
+        for filename in os.listdir(constants.LEELA_MODEL_DIRECTORY):
+            if filename.endswith(".pb.gz"):
+                match = re.search(exp, filename)
+                if match is None:
+                    n_filters = -1
+                    n_blocks = -1
+                else:
+                    n_filters = int(match.group("n_filters"))
+                    n_blocks = int(match.group("n_blocks"))
+                model_df.append(
+                    [
+                        filename,
+                        "LEELA",
+                        n_blocks,
+                        n_filters,
+                    ]
+                )
+    return model_df
+
+
+def save_model(tmp_file_path):
+    """
+    Save the model to the model directory.
+    """
+    popen = subprocess.Popen(
+        ["file", tmp_file_path],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    popen.wait()
+    if popen.returncode != 0:
+        raise RuntimeError
+    file_desc = popen.stdout.read().decode("utf-8").split(tmp_file_path)[1].strip()
+    rename_match = re.search(r"was\s\"(?P<name>.+)\"", file_desc)
+    type_match = re.search(r"\:\s(?P<type>[a-zA-Z]+)", file_desc)
+    if rename_match is None or type_match is None:
+        raise RuntimeError
+    model_name = rename_match.group("name")
+    model_type = type_match.group("type")
+    if model_type != "gzip":
+        raise RuntimeError
+    os.rename(
+        tmp_file_path,
+        f"{constants.LEELA_MODEL_DIRECTORY}/{model_name}.gz",
+    )
+    try:
+        backends.describenet(
+            f"{constants.LEELA_MODEL_DIRECTORY}/{model_name}.gz",
+        )
+    except RuntimeError:
+        os.remove(f"{constants.LEELA_MODEL_DIRECTORY}/{model_name}.gz")
+        raise RuntimeError
+
+
+def list_models():
+    """
+    List the models in the model directory.
+    """
+    models_info = utils.get_models_info()
+    return sorted([[model_info[0]] for model_info in models_info])
+
+
+def on_select_model_df(
+    evt: gr.SelectData,
+):
+    """
+    When a model is selected, update the statement.
+    """
+    return evt.value
+
+
+def convert_model(
+    model_name: str,
+):
+    """
+    Convert the model.
+    """
+    if model_name == "":
+        gr.Warning(
+            "Please select a model.",
+        )
+        return list_models(), ""
+    if model_name.endswith(".onnx"):
+        gr.Warning(
+            "ONNX conversion not implemented.",
+        )
+        return list_models(), ""
+    try:
+        backends.convert_to_onnx(
+            f"{constants.LEELA_MODEL_DIRECTORY}/{model_name}",
+            f"{constants.MODEL_DIRECTORY}/{model_name[:-6]}.onnx",
+        )
+    except RuntimeError:
+        gr.Warning(
+            f"Could not convert net at `{model_name}`.",
+        )
+        return list_models(), "Conversion failed"
+    return list_models(), "Conversion successful"
+
+
+def upload_model(
+    model_file: gr.File,
+):
+    """
+    Convert the model.
+    """
+    if model_file is None:
+        gr.Warning(
+            "File not uploaded.",
+        )
+        return list_models()
+    try:
+        id = uuid.uuid4()
+        tmp_file_path = f"{constants.LEELA_MODEL_DIRECTORY}/{id}"
+        with open(
+            tmp_file_path,
+            "wb",
+        ) as f:
+            f.write(model_file)
+        utils.save_model(tmp_file_path)
+    except RuntimeError:
+        gr.Warning(
+            "Invalid file type.",
+        )
+    finally:
+        if os.path.exists(tmp_file_path):
+            os.remove(tmp_file_path)
+    return list_models()
+
+
+def get_model_description(
+    model_name: str,
+):
+    """
+    Get the model description.
+    """
+    if model_name == "":
+        gr.Warning(
+            "Please select a model.",
+        )
+        return ""
+    if model_name.endswith(".onnx"):
+        gr.Warning(
+            "ONNX description not implemented.",
+        )
+        return ""
+    try:
+        description = backends.describenet(
+            f"{constants.LEELA_MODEL_DIRECTORY}/{model_name}",
+        )
+    except RuntimeError:
+        raise gr.Error(
+            f"Could not describe net at `{model_name}`.",
+        )
+    return description
+
+
+def get_model_path(
+    model_name: str,
+):
+    """
+    Get the model path.
+    """
+    if model_name == "":
+        gr.Warning(
+            "Please select a model.",
+        )
+        return None
+    if model_name.endswith(".onnx"):
+        return f"{constants.MODEL_DIRECTORY}/{model_name}"
+    else:
+        return f"{constants.LEELA_MODEL_DIRECTORY}/{model_name}"
+
+
+with gr.Blocks() as interface:
+    model_file = gr.File(type="binary")
+    upload_button = gr.Button(
+        value="Upload",
+    )
+    with gr.Row():
+        with gr.Column(scale=2):
+            model_df = gr.Dataframe(
+                headers=["Available models"],
+                datatype=["str"],
+                interactive=False,
+                type="array",
+                value=list_models,
+            )
+        with gr.Column(scale=1):
+            with gr.Row():
+                model_name = gr.Textbox(label="Selected model", lines=1, interactive=False, scale=7)
+            conversion_status = gr.Textbox(
+                label="Conversion status",
+                lines=1,
+                interactive=False,
+            )
+
+    convert_button = gr.Button(
+        value="Convert",
+    )
+    describe_button = gr.Button(
+        value="Describe model",
+    )
+    model_description = gr.Textbox(
+        label="Model description",
+        lines=1,
+        interactive=False,
+    )
+    download_button = gr.Button(
+        value="Get download link",
+    )
+    download_file = gr.File(
+        type="filepath",
+        label="Download link",
+        interactive=False,
+    )
+
+    model_df.select(
+        on_select_model_df,
+        None,
+        model_name,
+    )
+    upload_button.click(
+        upload_model,
+        model_file,
+        model_df,
+    )
+    convert_button.click(
+        convert_model,
+        model_name,
+        [model_df, conversion_status],
+    )
+    describe_button.click(
+        get_model_description,
+        model_name,
+        model_description,
+    )
+    download_button.click(
+        get_model_path,
+        model_name,
+        download_file,
+    )

demo/leela-models/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

demo/onnx-models/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

demo/utils.py

@@ -0,0 +1,52 @@
+
+import gradio as gr
+import chess.svg
+from typing import Optional
+
+from lczerolens.board import LczeroBoard
+
+from . import constants
+
+
+def create_board_figure(
+    board: LczeroBoard,
+    *,
+    orientation: bool = chess.WHITE,
+    arrows: str = "",
+    square: str = "",
+    name: str = "board",
+):
+    try:
+        if arrows:
+            arrows_list = arrows.split(" ")
+            chess_arrows = []
+            for arrow in arrows_list:
+                from_square, to_square = arrow[:2], arrow[2:]
+                chess_arrows.append(
+                    (
+                        chess.parse_square(from_square),
+                        chess.parse_square(to_square),
+                    )
+                )
+        else:
+            chess_arrows = []
+    except ValueError:
+        chess_arrows = []
+        gr.Warning("Invalid arrows, using none.")
+
+    try:
+        color_dict = {chess.parse_square(square): "#FF0000"} if square else {}
+    except ValueError:
+        color_dict = {}
+        gr.Warning("Invalid square, using none.")
+
+    svg_board = chess.svg.board(
+        board,
+        size=350,
+        orientation=orientation,
+        arrows=chess_arrows,
+        fill=color_dict,
+    )
+    with open(f"{constants.FIGURE_DIRECTORY}/{name}.svg", "w") as f:
+        f.write(svg_board)
+    return f"{constants.FIGURE_DIRECTORY}/{name}.svg"

pyproject.toml

@@ -0,0 +1,15 @@
+[project]
+name = "lczerolens-backends-demo"
+version = "0.1.0"
+description = "Demo lczerolens backends features."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "gdown>=5.2.0",
+    "gradio>=5.20.1",
+    "lczerolens>=0.3.1",
+    "lczero-bindings",
+]
+
+[tool.uv.sources]
+lczero-bindings = { git = "https://github.com/LeelaChessZero/lc0.git", rev = "dfcd1c314150b93125697491bef1221841443c18" }

requirements.txt

@@ -0,0 +1,2 @@
+lczerolens>=0.3.1
+lczero-bindings @ git+https://github.com/LeelaChessZero/lc0.git