Adding wandb as an optional dependency with the relevant instructions

metavoiceio · Mar 13, 2024 · 84db8e9 · 84db8e9
1 parent d64da3f
commit 84db8e9
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -99,8 +99,13 @@ poetry run finetune --train ./datasets/sample_dataset.csv --val ./datasets/sampl
 
 In order to set hyperparameters such as learning rate, what to freeze, etc, you
 can edit the [finetune_params.py](./fam/llm/config/finetune_params.py) file.
-We've got a light integration with W&B that can be enabled via setting
-`wandb_log = True`.
+
+We've got a light & optional integration with W&B that can be enabled via setting
+`wandb_log = True` & by installing the appropriate dependencies.
+
+```bash
+poetry install -E observable
+```
 
 ## Upcoming
 - [x] Faster inference ⚡

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,11 +23,14 @@ pydub = "^0.25.1"
 gradio = "^4.20.1"
 huggingface_hub = "^0.21.4"
 click = "^8.1.7"
-wandb = "^0.16.4" # should be an optional dependency
+wandb = { version = "^0.16.4", optional = true }
 
 [tool.poetry.dev-dependencies]
 pytest = "^8.0.2"
 
+[tool.poetry.extras]
+observable = ["wandb"]
+
 [tool.poetry.scripts]
 finetune = "fam.llm.finetune:main"