Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Commit

Permalink
updated contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
binaryaaron authored and aittalam committed Aug 6, 2024
1 parent 53b5ba2 commit 4ba06f7
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,23 @@ development dependencies.
You can execute Ruff by calling `ruff --fix .` or `ruff format .` from the workspace root.
Ruff will pick up the configuration defined in the `pyproject.toml` file automatically.


## Updating deps
Update deps in `pyproject.toml` and ensure you can `pip-compile` them as follows:

pip-tools:
```
pip install pip-tools
pip-compile -o requirements.lock --all-extras pyproject.toml
```

uv:
```
pip install uv
uv pip compile --python-version=3.11.9 --all-extras --universal -o requirements.lock pyproject.toml
```


## Testing a development branch on Ray

LM Buddy is intended to be installed as a pip requirement in the runtime environment of a Ray job.
Expand All @@ -40,11 +57,11 @@ as shown below:
```
# pip-tools
pip install pip-tools
pip-compile -o requirements.txt pyproject.toml
pip-compile -o requirements.txt --all-extras pyproject.toml

# uv
pip install uv
uv pip compile -o requirements.txt pyproject.toml
uv pip compile --python-version=3.11.9 --all-extras --universal -o requirements.txt pyproject.toml
```

2. When submitting a job to a Ray cluster, specify in the Ray runtime environment the following:
Expand Down

0 comments on commit 4ba06f7

Please sign in to comment.