Skip to content

Commit 747d3ab

Browse files
Update README with uv add command and clarify Hydra/W&B are optional
Co-authored-by: kaustubhharapanahalli <22560434+kaustubhharapanahalli@users.noreply.github.com>
1 parent cc53d37 commit 747d3ab

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A comprehensive Python project template designed specifically for research devel
99
- **Comprehensive Linting & Type Checking**: Pre-configured with mypy, isort, pylint, black, pydocstyle, and flake8
1010
- **Pre-commit Hooks**: Automated code quality checks before each commit
1111
- **CI/CD Integration**: GitHub Actions workflow for continuous integration on PRs
12-
- **Experiment Tracking**: Ready-to-use configuration for Hydra and Weights & Biases (W&B)
12+
- **Experiment Tracking**: Ready-to-use configuration for Hydra and Weights & Biases (W&B) (optional dependencies)
1313

1414
## Directory Structure
1515

@@ -79,6 +79,8 @@ powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
7979

8080
This template is designed to support reproducible research experiments using [Hydra](https://hydra.cc/) for configuration management and [Weights & Biases (W&B)](https://wandb.ai/) for experiment tracking.
8181

82+
> **Note**: Hydra and W&B are included as dependencies in this template for convenience, but they are **optional**. You can remove them from `pyproject.toml` if you don't need experiment tracking or configuration management features.
83+
8284
#### Basic Experiment Execution
8385

8486
Place your experiment scripts in the `experiments/` directory:
@@ -276,18 +278,24 @@ The GitHub Actions workflow (`.github/workflows/pr-monitor.yml`) automatically r
276278

277279
## Adding New Dependencies
278280

279-
Use uv to add new dependencies:
281+
Use uv to add new dependencies to your project. The `uv add` command automatically installs the package and updates `pyproject.toml`:
280282

281283
```bash
282284
# Add a runtime dependency
283-
uv pip install package-name
284-
# Then add it to pyproject.toml under [project.dependencies]
285+
uv add package-name
285286

286287
# Add a development dependency
287-
uv pip install package-name
288-
# Then add it to pyproject.toml under [project.optional-dependencies.dev]
288+
uv add --dev package-name
289+
290+
# Add a specific version
291+
uv add "package-name>=1.0.0"
292+
293+
# Add multiple packages at once
294+
uv add package1 package2 package3
289295
```
290296

297+
After adding dependencies, make sure to commit the updated `pyproject.toml` to keep your project configuration in sync.
298+
291299
## Configuration Files
292300

293301
All linter and type-checker configurations are located in the `.dev-config/` directory:

0 commit comments

Comments
 (0)