-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #43 from automl/docs
Setup for automated doc generation via mkdocs
- Loading branch information
Showing
30 changed files
with
148 additions
and
216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,13 +7,13 @@ on: | |
# Trigger on any push to the main | ||
push: | ||
branches: | ||
- main | ||
- master | ||
- development | ||
|
||
# Trigger on any push to a PR that targets main | ||
pull_request: | ||
branches: | ||
- main | ||
- master | ||
- development | ||
|
||
permissions: | ||
|
@@ -23,49 +23,16 @@ env: | |
name: DEHB | ||
|
||
jobs: | ||
build-and-deploy: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: "3.8" | ||
|
||
- name: Install dependencies | ||
run: | | ||
pip install ".[dev]" | ||
- name: Make docs | ||
run: | | ||
make clean | ||
make docs | ||
- name: Pull latest gh-pages | ||
if: (contains(github.ref, 'development') || contains(github.ref, 'main')) | ||
run: | | ||
cd .. | ||
git clone https://github.com/${{ github.repository }}.git --branch gh-pages --single-branch gh-pages | ||
- name: Copy new docs into gh-pages | ||
if: (contains(github.ref, 'development') || contains(github.ref, 'main')) | ||
run: | | ||
branch_name=${GITHUB_REF##*/} | ||
cd ../gh-pages | ||
rm -rf $branch_name | ||
cp -r ../${{ env.name }}/docs/build/html $branch_name | ||
- name: Push to gh-pages | ||
if: (contains(github.ref, 'development') || contains(github.ref, 'main')) | ||
run: | | ||
last_commit=$(git log --pretty=format:"%an: %s") | ||
cd ../gh-pages | ||
branch_name=${GITHUB_REF##*/} | ||
git add $branch_name/ | ||
git config --global user.name 'Github Actions' | ||
git config --global user.email '[email protected]' | ||
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} | ||
git commit -am "$last_commit" | ||
git push | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.x | ||
- uses: actions/cache@v3 | ||
with: | ||
key: ${{ github.ref }} | ||
path: .cache | ||
- run: pip install "mkdocs-material" "mkdocstrings[python]" | ||
- run: mkdocs gh-deploy --force |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Welcome to DEHB | ||
|
||
Evolutionary Hyperband for Scalable, Robust and Efficient Hyperparameter Optimization. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Bracket manager | ||
|
||
::: dehb.utils.bracket_manager |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# DE | ||
|
||
::: dehb.optimizers.de |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# DEHB | ||
|
||
::: dehb.optimizers.dehb |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Examples | ||
======== | ||
|
||
We provide several examples of how to use DEHB with Python. The examples were structured in order to give the user an | ||
introduction to the interface of DEHB and how to use it. Moreover the examples show how to use DEHB with and without | ||
the ConfigSpace library and an exemplary optimization with PyTorch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
site_name: DEHB | ||
|
||
nav: | ||
- Home: index.md | ||
- Code Reference: | ||
- DEHB: references/dehb.md | ||
- DE: references/de.md | ||
- Bracket Manager: references/bracket_manager.md | ||
|
||
theme: | ||
name: material | ||
logo: assets/automl_org.png | ||
favicon: assets/automl_org.png | ||
icon: | ||
repo: fontawesome/brands/github | ||
features: | ||
- content.code.annotate | ||
- content.code.copy | ||
- navigation.footer | ||
- navigation.tabs | ||
- navigation.tabs.sticky | ||
- toc.follow | ||
- header.autohide | ||
- search.suggest | ||
- search.highlight | ||
- search.share | ||
font: | ||
text: Roboto | ||
code: Roboto Mono | ||
palette: | ||
- scheme: slate | ||
media: "(prefers-color-scheme: dark)" | ||
primary: indigo | ||
accent: deep purple | ||
toggle: | ||
icon: material/eye-outline | ||
name: Switch to light mode | ||
|
||
# Palette toggle for light mode | ||
- scheme: default | ||
media: "(prefers-color-scheme: light)" | ||
primary: indigo | ||
accent: deep purple | ||
toggle: | ||
icon: material/eye | ||
name: Switch to dark mode | ||
|
||
plugins: | ||
- search | ||
- mkdocstrings: | ||
default_handler: python | ||
enable_inventory: true | ||
custom_templates: docs/_templates | ||
handlers: | ||
python: | ||
paths: [src] | ||
options: # https://mkdocstrings.github.io/python/usage/ | ||
docstring_section_style: spacy | ||
show_docstring_attributes: true | ||
show_docstring_description: true | ||
show_root_heading: false | ||
show_root_toc_entry: false | ||
show_object_full_path: false | ||
merge_init_into_class: true | ||
docstring_style: google | ||
show_if_no_docstring: false | ||
show_bases: true | ||
show_source: true | ||
members_order: "source" | ||
show_signature: true | ||
separate_signature: false | ||
show_signature_annotations: false |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import datetime | ||
from .optimizers import DE, AsyncDE | ||
from .optimizers import DEHB | ||
from .utils import SHBracketManager | ||
|
||
name = "DEHB" | ||
author = ( | ||
"N. Awad and N. Mallik and F. Hutter" | ||
) | ||
copyright = f"Copyright {datetime.date.today().strftime('%Y')}, Noor Awad, Neeratyoy Mallik and Frank Hutter" | ||
version = "0.0.5" |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.