Skip to content
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.

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

Improved README installation instructions and added usage examples #338

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,30 @@ By default, predictions will be saved to `depth_predictions.csv`. Run `zamba dep

See the [depth estimation page](https://zamba.drivendata.org/docs/stable/models/depth/) for more details.

### Common Setup Issues and Troubleshooting:
If you receive an error about FFmpeg not being found, ensure that it is installed correctly and added to your system's PATH. You can verify the installation by running:

ffmpeg -version

If ffmpeg is not found, install it via:

sudo apt-get install ffmpeg
or
brew install ffmpeg

Ensure you have Python 3.11 or greater (python --version) check.
If you are using a different version, simply create a new virtual environment with the correct versions

conda create -n zamba-env python=3.11
conda activate zamba-env

If your video files are not recognized by zamba, make sure they are in one of the supported formats by FFmpeg. You can convert videos to a supported format using FFmpeg:

ffmpeg -i input_video.avi output_video.mp4

If you're running into memory issues while processing large video datasets, try reducing the number of videos processed at once by using the --batch-size option:

zamba predict --data-dir path/to/videos --batch-size 10

## Contributing

Expand Down