Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,12 @@ See the [Quickstart](https://zamba.drivendata.org/docs/stable/quickstart/) page

Zamba defaults to training a model for classifying videos:
```console
$ zamba train --data-dir path/to/videos --labels path_to_labels.csv --save_dir my_trained_model
$ zamba train --data-dir path/to/videos --labels path_to_labels.csv --save-dir my_trained_model
```

Training a model for images is similar:
```console
$ zamba image train --data-dir path/to/images --labels path_to_labels.csv --save_dir my_trained_model
$ zamba image train --data-dir path/to/images --labels path_to_labels.csv --save-dir my_trained_model
```

The newly trained model will be saved to the specified save directory. The folder will contain a model checkpoint as well as training configuration, model hyperparameters, and validation and test metrics. Run `zamba train --help` or `zamba image train --help` to list all possible options to pass to `train`.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extra-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For using a YAML file with the Python package and other details, see the [YAML C

=== "CLI"
```console
zamba predict --data-dir example_vids/ --weight_download_region asia
zamba predict --data-dir example_vids/ --weight-download-region asia
```
=== "Python"
In Python this can be specified in [`PredictConfig`](configurations.md#prediction-arguments) or [`TrainConfig`](configurations.md#training-arguments):
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ For images, all the above is true except the command is `zamba image train`.
## Downloading model weights

**`zamba` needs to download the "weights" files for the models it uses to make predictions. On first run, it will download ~200-2000 MB of files with these weights depending which model you choose.**
Once a model's weights are downloaded, `zamba` will use the local version and will not need to perform this download again. If you are not in the United States, we recommend running the above command with the additional flag either `--weight_download_region eu` or `--weight_download_region asia` depending on your location. The closer you are to the server, the faster the downloads will be.
Once a model's weights are downloaded, `zamba` will use the local version and will not need to perform this download again. If you are not in the United States, we recommend running the above command with the additional flag either `--weight-download-region eu` or `--weight-download-region asia` depending on your location. The closer you are to the server, the faster the downloads will be.

<a id='getting-help'></a>

Expand Down Expand Up @@ -212,7 +212,7 @@ Options:
If True, we just return a video and the name
of the most likely class. If False, we
return a probability or indicator (depending
on --proba_threshold) for every possible
on --proba-threshold) for every possible
class.
--num-workers INTEGER Number of subprocesses to use for data
loading.
Expand Down
2 changes: 1 addition & 1 deletion zamba/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ def predict(
output_class_names: bool = typer.Option(
None,
help="If True, we just return a video and the name of the most likely class. If False, "
"we return a probability or indicator (depending on --proba_threshold) for every "
"we return a probability or indicator (depending on --proba-threshold) for every "
"possible class.",
),
num_workers: int = typer.Option(
Expand Down