From 879e5df77608f63fc2e5bc5fd34bd19f40a82c1a Mon Sep 17 00:00:00 2001 From: Romain Beaumont Date: Thu, 8 Feb 2024 17:15:37 +0100 Subject: [PATCH 1/2] Add contribution guide. Should help merging PR without introducing issues --- CONTRIBUTE.md | 26 ++++++++++++++++++++++++++ README.md | 2 ++ pull_request_template.md | 1 + 3 files changed, 29 insertions(+) create mode 100644 CONTRIBUTE.md create mode 100644 pull_request_template.md diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 00000000..8fb3a733 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,26 @@ +# Contribution guide + +video2dataset open contributions to add new features, improve efficiency or improve the code health. + +## How to validate your changes ? + +Before merging a change (especially for non trivial changes), we ask: + +* to make sure the linting is passing, you can run `make black` and `make lint` locally and then check the status in a PR +* to make sure the existing tests are passing, you can run `make test` locally and then check the status in a PR +* to add new tests for new features or for bug fixes +* to run manually an efficiency test. video2dataset must remain fast so this is important + +## Efficiency test + +To test the efficiency of video2dataset, you can follow [this example to download webvid](dataset_examples/WebVid.md) + +Using 16 processes with 16 threads each is particularly important to check the speed. Enabling wandb is also important. + +You can run with only the `results_2M_val` to reduce the run time of this test. + +You should observe 14.4 videos/s/core in wandb. + +Please post the wandb link in the PR to show this is working. It will make it faster for the reviewer to merge the PR. + + diff --git a/README.md b/README.md index 6d893dc5..2e55c9ff 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ Easily create large video dataset from video urls. Can download and package 10M If you believe in making reusable tools to make data easy to use for ML and you would like to contribute, please join the [DataToML](https://discord.gg/ep8yUUtCnp) chat. +If you would like to contribute to video2dataset, please read [CONTRIBUTE.md](CONTRIBUTE.md) + ## Install ```bash diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 00000000..dfdd61c8 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1 @@ +* [ ] I have read CONTRIBUTE.md \ No newline at end of file From 9f6f5818c2de92057cef5ca9dad2b6d7793ad60c Mon Sep 17 00:00:00 2001 From: Romain Beaumont Date: Thu, 8 Feb 2024 17:16:41 +0100 Subject: [PATCH 2/2] reword --- CONTRIBUTE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 8fb3a733..963e7155 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -4,12 +4,12 @@ video2dataset open contributions to add new features, improve efficiency or impr ## How to validate your changes ? -Before merging a change (especially for non trivial changes), we ask: +Before merging a change (especially for non trivial changes), we ask to: -* to make sure the linting is passing, you can run `make black` and `make lint` locally and then check the status in a PR -* to make sure the existing tests are passing, you can run `make test` locally and then check the status in a PR -* to add new tests for new features or for bug fixes -* to run manually an efficiency test. video2dataset must remain fast so this is important +* make sure the linting is passing, you can run `make black` and `make lint` locally and then check the status in a PR +* make sure the existing tests are passing, you can run `make test` locally and then check the status in a PR +* add new tests for new features or for bug fixes +* run manually an efficiency test. video2dataset must remain fast so this is important ## Efficiency test