Skip to content

Commit

Permalink
CI: Fix doc build (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywonchung authored Apr 29, 2024
1 parent 4002076 commit 48c3cd2
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/deploy_homepage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
- 'docs/**'
- 'zeus/**'
- 'mkdocs.yml'
- 'Dockerfile'
- 'docker/Dockerfile'
- '.github/workflows/deploy_homepage.yaml'

jobs:
Expand All @@ -30,6 +30,6 @@ jobs:
restore-keys: |
mkdocs-material-
- name: Install homepage build dependencies
run: pip install -r docs/requirements.txt
run: pip install '.[docs]'
- name: Build homepage
run: mkdocs gh-deploy --force
6 changes: 3 additions & 3 deletions docs/batch_size_optimizer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ sequenceDiagram;
ZEUS_BSO_ECHO_SQL="True"
```

If you want to use different databases, you need to add `ZEUS_BSO_DATABASE_URL` as an environment variable. See [Remark](#remark-about-server) for detail.
If you want to use different databases, you need to add `ZEUS_BSO_DATABASE_URL` as an environment variable. See [Remark](#notes-on-the-server) for detail.
Also, if you are running using docker-compose or Kubernetes, you need to change the image name under `db` in the docker-compose file.

3. Running a server
Expand Down Expand Up @@ -146,7 +146,7 @@ sequenceDiagram;

Now the server is good to go!

### Remark about the server
### Notes on the server

Zeus Batch Size Optimizer server is using Sqlalchemy to support various types of databases. However, you need to download the corresponding async connection driver.
As a default, we are using Mysql. You can add installation code to `docker/batch_size_optimizer/migration.Dockerfile` and `docker/batch_size_optimizer/server.Dockerfile`. Refer to those files for reference.
Expand Down Expand Up @@ -189,7 +189,7 @@ As a default, we are using Mysql. You can add installation code to `docker/batch
bso.on_evaluate(metric)
```

### Remark about the client
### Notes on the client

Training can fail if

Expand Down
1 change: 0 additions & 1 deletion zeus/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
- [`_legacy`][zeus._legacy.policy]: Legacy code mostly to keep our papers reproducible
- [`device`][zeus.device]: Abstraction layer over compute devices
- [`callback`][zeus.callback]: Callback definition
- [`analyze`][zeus.analyze]: Functions for analyzing log files
"""

__version__ = "0.8.2"

0 comments on commit 48c3cd2

Please sign in to comment.