Skip to content

Commit

Permalink
docs: consolidate setup Instructions into a single page (#144)
Browse files Browse the repository at this point in the history
  • Loading branch information
rmuraix authored Jan 28, 2025
1 parent 9896b6f commit 05c45fd
Show file tree
Hide file tree
Showing 8 changed files with 49 additions and 65 deletions.
14 changes: 14 additions & 0 deletions docs/meta/install_conda.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
# Setup Environment

## Using the YAML File

If you want to quickly set up the `conda` environment with all the required dependencies, use the `conda_env.yml` file. Run the following command:

```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

## From Scratch

Just steps to install conda and create a new environment from scratch.

```bash
conda create -n video_features
conda install pytorch torchvision torchaudio pytorch-cuda=12.1 -c pytorch -c nvidia
Expand Down
13 changes: 4 additions & 9 deletions docs/models/clip.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,11 @@ We additionally output timesteps in ms for each feature and fps of the video.

---

## Set up the Environment for CLIP
Setup `conda` environment. Requirements are in file `conda_env.yml`
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1Zd7r8uKGLGSxlil4PPnXk_4I3KOsjPpO?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
Expand Down Expand Up @@ -65,6 +57,9 @@ python main.py \
---

## Examples

Make sure the environment is set up correctly. For instructions, refer to [Setup Environment](../meta/install_conda.md).

Start by activating the environment
```bash
conda activate video_features
Expand Down
14 changes: 5 additions & 9 deletions docs/models/i3d.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,12 @@ You may check if the predicted distribution satisfies your requirements for an a

---

## Set up the Environment for I3D
Check if you have a correct conda environment installed
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1LKoytZmNxtC-EuCp7pHDM6sFvK1XdwlW?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
conda activate video_features
Expand All @@ -73,6 +66,9 @@ python main.py \
---

## Examples

Make sure the environment is set up correctly. For instructions, refer to [Setup Environment](../meta/install_conda.md).

Activate the environment
```bash
conda activate video_features
Expand Down
15 changes: 5 additions & 10 deletions docs/models/r21d.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,14 @@ which spans 0.64 seconds of the video recorded at 25 fps.
In the default case, the features will be of size `Tv x 512` where `Tv = duration / 0.64`.
Specify, `model_name`, `step_size` and `stack_size` to change the default behavior.


---

## Set up the Environment for R(2+1)D
Setup `conda` environment. Requirements are in file `conda_env.yml`
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1csJgkVQ3E2qOyVlcOM-ACHGgPBBKwE2Y?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
conda activate video_features
Expand Down Expand Up @@ -81,6 +73,9 @@ python main.py \
---

## Example

Make sure the environment is set up correctly. For instructions, refer to [Setup Environment](../meta/install_conda.md).

Start by activating the environment
```bash
conda activate video_features
Expand Down
13 changes: 4 additions & 9 deletions docs/models/raft.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,12 @@ The optical flow frames have the same size as the video input or as specified by

---

## Set up the Environment for RAFT
Setup `conda` environment. Requirements for RAFT are similar to the torchvision zoo, which uses `conda_env.yml`
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/18I95Rn1B3a2ISfD9b-o4o93m3XuHbcIY?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
conda activate video_features
Expand Down Expand Up @@ -69,6 +62,8 @@ To use `show_pred=true`, a screen must be attached to the machine or X11 forward

## Examples

Make sure the environment is set up correctly. For instructions, refer to [Setup Environment](../meta/install_conda.md).

Start by activating the environment
```bash
conda activate video_features
Expand Down
14 changes: 5 additions & 9 deletions docs/models/resnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,12 @@ We additionally output timesteps in ms for each feature and fps of the video. We

---

## Set up the Environment for ResNet
Setup `conda` environment. Requirements are in file `conda_env.yml`
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/17VLdf4abQT2eoMjc6ziJ9UaRaOklTlP0?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
conda activate video_features
Expand Down Expand Up @@ -63,6 +56,9 @@ python main.py \
---

## Examples

Make sure the environment is set up correctly. For instructions, refer to [Setup Environment](../meta/install_conda.md).

Start by activating the environment
```bash
conda activate video_features
Expand Down
12 changes: 2 additions & 10 deletions docs/models/s3d.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,14 @@ What is extracted exactly?
The inputs to the classification head (see `S3D.fc` and `S3D.forward`) that were average-pooled
across the time dimension.


---

## Set up the Environment for S3D
Setup `conda` environment. Requirements are in file `conda_env.yml`
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1HUlYcOJf_dArOcAaR9jaQHuM5CAZiNZc?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
conda activate video_features
Expand Down
19 changes: 10 additions & 9 deletions docs/models/vggish.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,12 @@ The extraction of VGGish features is implemeted as a wrapper of the TensorFlow i

---

## Set up the Environment for VGGish
Setup `conda` environment. Requirements are in file `conda_env.yml`
```bash
# it will create a new conda environment called 'video_features' on your machine
conda env create -f conda_env.yml
```

---

## Quick Start

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1r_8OnmwXKwmH0n4RxBfuICVBgpbJt_Fs?usp=sharing)

Ensure that the environment is properly set up before proceeding. See [Setup Environment](../meta/install_conda.md) for detailed instructions.

Activate the environment
```bash
conda activate video_features
Expand Down Expand Up @@ -56,6 +49,14 @@ python main.py \

## Example

Make sure the environment is set up correctly. For instructions, refer to [Setup Environment](../meta/install_conda.md).

Activate the environment

```bash
conda activate video_features
```

The video paths can be specified as a `.txt` file with paths.
```bash
python main.py \
Expand Down

0 comments on commit 05c45fd

Please sign in to comment.