Skip to content

Commit

Permalink
Fix docs links (#155)
Browse files Browse the repository at this point in the history
* update readme links

* update makefile
  • Loading branch information
ejm714 authored Oct 26, 2021
1 parent 6b69a9e commit 33c1c2a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ docs-setup:
| sed 's|Visit https://zamba.drivendata.org/docs/ for full documentation and tutorials.||g' \
| sed 's|https://user-images.githubusercontent.com /46792169/137787221-de590183-042e-4d30-b32b-1d1c2cc96589.mov| \
<script id="asciicast-1mXKsDiPzgyAZwk8CbdkrG2ac" src="https://asciinema.org/a/1mXKsDiPzgyAZwk8CbdkrG2ac.js" async data-autoplay="true" data-loop=1></script>|g' \
| sed 's|https://zamba.drivendata.org/docs/||g' \
| sed 's|https://zamba.drivendata.org/docs/stable/||g' \
> docs/docs/index.md

sed 's|https://zamba.drivendata.org/docs/|../|g' HISTORY.md > docs/docs/changelog.md
sed 's|https://zamba.drivendata.org/docs/stable/|../|g' HISTORY.md > docs/docs/changelog.md

## Build the static version of the docs
docs: docs-setup
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ Then run:
pip install zamba
```

See the [Installation](https://zamba.drivendata.org/docs/install/) page of the documentation for details.
See the [Installation](https://zamba.drivendata.org/docs/stable/install/) page of the documentation for details.

## Getting started

Once you have `zamba` installed, some good starting points are:

- The [Quickstart](https://zamba.drivendata.org/docs/quickstart/) page for basic examples of usage
- The user tutorial for either [classifying videos](https://zamba.drivendata.org/docs/predict-tutorial/) or [training a model](https://zamba.drivendata.org/docs/train-tutorial/) depending on what you want to do with `zamba`
- The [Quickstart](https://zamba.drivendata.org/docs/stable/quickstart/) page for basic examples of usage
- The user tutorial for either [classifying videos](https://zamba.drivendata.org/docs/stable/predict-tutorial/) or [training a model](https://zamba.drivendata.org/docs/stable/train-tutorial/) depending on what you want to do with `zamba`

## Example usage

Expand Down Expand Up @@ -77,7 +77,7 @@ $ zamba predict --data-dir path/to/videos

By default, predictions will be saved to `zamba_predictions.csv`. Run `zamba predict --help` to list all possible options to pass to `predict`.

See the [Quickstart](https://zamba.drivendata.org/docs/quickstart/) page or the user tutorial on [classifying videos](https://zamba.drivendata.org/docs/predict-tutorial/) for more details.
See the [Quickstart](https://zamba.drivendata.org/docs/stable/quickstart/) page or the user tutorial on [classifying videos](https://zamba.drivendata.org/docs/stable/predict-tutorial/) for more details.

### Training a model

Expand All @@ -87,7 +87,7 @@ $ zamba train --data-dir path/to/videos --labels path_to_labels.csv --save_dir m

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` to list all possible options to pass to `train`.

See the [Quickstart](https://zamba.drivendata.org/docs/quickstart/) page or the user tutorial on [training a model](https://zamba.drivendata.org/docs/train-tutorial/) for more details.
See the [Quickstart](https://zamba.drivendata.org/docs/stable/quickstart/) page or the user tutorial on [training a model](https://zamba.drivendata.org/docs/stable/train-tutorial/) for more details.

## Running the `zamba` test suite

Expand All @@ -99,4 +99,4 @@ The command is (from the project root):
$ make tests
```

See the docs page on [contributing to `zamba`](https://zamba.drivendata.org/docs/contribute/index.md) for details.
See the docs page on [contributing to `zamba`](https://zamba.drivendata.org/docs/stable/contribute/index.md) for details.

0 comments on commit 33c1c2a

Please sign in to comment.