Skip to content

document how to install git-hosted python packages #1383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 22, 2023
Merged

document how to install git-hosted python packages #1383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ build:
- pytorch==2.0.1
system_packages:
- "ffmpeg"
- "libavcodec-dev"
- "git"
predict: "predict.py:Predictor"
```

Expand Down Expand Up @@ -49,7 +49,7 @@ When you use `cog run` or `cog predict`, Cog will automatically pass the `--gpus

### `python_packages`

A list of Python packages to install, in the format `package==version`. For example:
A list of Python packages to install from the PyPi package index, in the format `package==version`. For example:

```yaml
build:
Expand All @@ -58,14 +58,24 @@ build:
- tensorflow==2.5.0
```

To install Git-hosted Python packages, add `git` to the `system_packages` list, then use the `git+https://` syntax to specify the package name. For example:

````yaml
build:
system_packages:
- "git"
python_packages:
- "git+https://github.com/m-bain/whisperX.git"
```

### `python_requirements`

A pip requirements file specifying the Python packages to install. For example:

```yaml
build:
python_requirements: requirements.txt
```
````

Your `cog.yaml` file can set either `python_packages` or `python_requirements`, but not both. Use `python_requirements` when you need to configure options like `--extra-index-url` or `--trusted-host` to fetch Python package dependencies.

Expand Down