Initial commit

.github/workflows/checks.yaml

@@ -0,0 +1,18 @@
+name: Checks
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+  workflow_dispatch: {}
+jobs:
+  checks:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - uses: pre-commit/[email protected]
+

.github/workflows/github-pages.yaml

@@ -0,0 +1,53 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install
+        env:
+          SECRET_GITHUB_TOKEN: ${{ secrets.SECRET_GITHUB_TOKEN }}
+        run: |
+          python -m pip install -U pip
+          pip install --progress-bar off .
+          pip install --progress-bar off ".[docs]"
+          pip install --progress-bar off git+https://github.com/optuna/optunahub.git
+      - name: Build
+        env:
+          SECRET_GITHUB_TOKEN: ${{ secrets.SECRET_GITHUB_TOKEN }}
+          OPTUNAHUB_NO_ANALYTICS: 1
+        run: |
+          cd docs
+          make html
+          cd ..
+      - name: Deploy
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+
+  deploy:
+    if: github.event_name == 'push'
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/update-readme.yaml

@@ -0,0 +1,24 @@
+on:
+    push:
+      branches:
+        - main
+
+jobs:
+    update-readme:
+      runs-on: ubuntu-latest
+      permissions:
+        contents: write
+      steps:
+        - uses: actions/checkout@v4
+        - uses: actions/setup-python@v5
+          with:
+            python-version: 3.11
+        - name: Install
+          run: |
+            python -m pip install -U pip
+            pip install --progress-bar off .
+        - run: python update_readme.py
+        - uses: stefanzweifel/git-auto-commit-action@v5
+          with:
+            commit_message: Update list in README
+            file_pattern: README.md

.gitignore

@@ -0,0 +1,116 @@
+# macOS metadata
+.DS_Store
+
+# Ignore files that examples create
+t10k-images-idx3-ubyte*
+t10k-labels-idx1-ubyte*
+train-images-idx3-ubyte*
+train-labels-idx1-ubyte*
+training.pt
+test.pt
+catboost_info/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# PyCharm
+.idea
+
+# VSCode
+.vscode
+.devcontainer
+
+# MyPy
+.mypy_cache
+
+# Sphinx
+docs/build/
+docs/source/reference/generated/
+docs/source/sg_execution_times.rst
+docs/source/recipes/**

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
+    hooks:
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
+        types_or: [python, pyi]
+      - id: ruff-format
+        types_or: [python, pyi]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+    - id: mypy
+      additional_dependencies: [
+        "types-PyYAML",
+      ]

README.md

@@ -0,0 +1,19 @@
+
+OptunaHub Registry
+==================
+
+# List of Packages
+
+## Samplers
+
+|Title|Description|
+| :---: | :---: |
+|[Demo Sampler](package/samplers/demo)|Demo Sampler of OptunaHub|
+|[Simulated Annealing Sampler](package/samplers/simulated_annealing)|Sampler based on simulated annealing algorithm.|
+|[Simple Sampler](package/samplers/simple)|An easy sampler base class to implement custom samplers.|
+
+## Visualization
+
+|Title|Description|
+| :---: | :---: |
+|[Plot Hypervolume History with Reference Point](package/visualization/plot_hypervolume_history_with_rp)|<img src="package/visualization/plot_hypervolume_history_with_rp/img/thumbnail.png" width="160px" height="120px" alt="Plot hypervolume history with the reference point information.">|

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,16 @@
+Docs
+====
+
+# Install Dependencies
+
+```sh
+pip install ".[docs]"
+```
+
+# Build the Docs
+
+```sh
+make html
+```
+
+open `build/html/index.html`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,51 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+from __future__ import annotations
+
+from sphinx_gallery.sorting import FileNameSortKey
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "OptunaHub Registry"
+copyright = "2024, Optuna team"
+author = "Optuna team"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx_gallery.gen_gallery",
+]
+
+templates_path = ["_templates"]
+source_suffix = ".rst"
+exclude_patterns = ["build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path: list[str] = []
+
+html_theme_options = {"navigation_depth": 2}
+
+# Sphinx Gallery
+sphinx_gallery_conf = {
+    "examples_dirs": [
+        "../../recipes",
+    ],
+    "gallery_dirs": [
+        "recipes",
+    ],
+    "within_subsection_order": FileNameSortKey,
+    "filename_pattern": r"/*\.py",
+    "first_notebook_cell": None,
+}

docs/source/index.rst

@@ -0,0 +1,11 @@
+Welcome to OptunaHub Registry's documentation!
+==============================================
+
+OptunaHub is a registry of third-party Optuna packages.
+It allows users to share and discover Optuna packages that are not included in the official Optuna distribution.
+The `optunahub-registry <https://github.com/optuna/optunahub-registry/>`_ is a GitHub repository that hosts the packages.
+See `optunahub <https://github.com/optuna/optunahub>`_ and its `documentation <https://optuna.github.io/optunahub/>`_ for API details.
+
+Recipes
+=======
+:doc:`recipes/001_first`