Open
Conversation
Collaborator
Author
|
@jeetv I am testing the contribution workflow. I mainly re-arranged the README.md and move the docs around. |
There was a problem hiding this comment.
Pull request overview
Updates project documentation and adds example configs/quickstart scripts to make OpenSportsLib easier to install, understand, and run.
Changes:
- Restructures the top-level README with quick links, install commands, and a simplified quickstart.
- Adds
examples/configs/*templates andexamples/quickstart/*scripts to demonstrate intended public API usage. - Moves/refreshes contributor & developer documentation (adds root
CONTRIBUTING.mdandDEVELOPERS.md, deletes somedocs/*pages).
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | New public-facing overview, install instructions, and quickstart snippets. |
| examples/quickstart/README.md | Brief index for quickstart scripts. |
| examples/quickstart/basic_classification.py | Minimal classification training/inference example. |
| examples/quickstart/basic_localization.py | Minimal localization training/inference example. |
| examples/configs/README.md | Explains how to use example YAML configs. |
| examples/configs/classification_video.yaml | Example video classification config template. |
| examples/configs/classification_tracking.yaml | Example tracking classification config template. |
| examples/configs/localization.yaml | Example localization config template. |
| DEVELOPERS.md | Repository structure + onboarding notes for developers. |
| CONTRIBUTING.md | Contributor workflow/setup guide at repo root. |
| docs/license.txt | Removed AGPL text from docs. |
| docs/contributing.md | Removed contributing page from docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| device: cuda # auto | cuda | cpu | ||
| gpu_id: 0 # device id for single gpu training | ||
| pip install "opensportslib[localization]" | ||
| pip install "opensportslib[tracking]" |
| 1. Classification | ||
| mvfouls = https://huggingface.co/datasets/OpenSportsLab/opensportslib-classification-vars/tree/mvfouls | ||
| svfouls = https://huggingface.co/datasets/OpenSportsLab/opensportslib-classification-vars/tree/svfouls | ||
| > Requires **Python 3.12+**. |
| - extracted features | ||
| - pretrained models and checkpoints | ||
|
|
||
| -- |
Comment on lines
+179
to
+181
| pip install -e ".[tracking]" | ||
| ``` | ||
|
|
Comment on lines
+153
to
+161
| ## Examples and documentation | ||
|
|
||
| Use the README for the fast start, then go deeper through: | ||
|
|
||
| - Full documentation: https://opensportslab.github.io/opensportslib/ | ||
| - Example configs: [examples/configs/](examples/configs/) | ||
| - Quickstart scripts: [examples/quickstart/](examples/quickstart/) | ||
| - Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md) | ||
| - Developer guide: [DEVELOPERS.md](DEVELOPERS.md) |
| @@ -0,0 +1,131 @@ | |||
| ASK: localization | |||
Comment on lines
+91
to
+131
| MODEL: | ||
| type: E2E | ||
| runner: | ||
| type: runner_e2e | ||
| backbone: | ||
| type: rny008_gsm | ||
| head: | ||
| type: gru | ||
| multi_gpu: true | ||
| load_weights: null | ||
| save_dir: ./checkpoints | ||
| work_dir: ${MODEL.save_dir} | ||
|
|
||
| TRAIN: | ||
| type: trainer_e2e | ||
| num_epochs: 10 | ||
| acc_grad_iter: 1 | ||
| base_num_valid_epochs: 30 | ||
| start_valid_epoch: 4 | ||
| valid_map_every: 1 | ||
| criterion_valid: map | ||
|
|
||
| criterion: | ||
| type: CrossEntropyLoss | ||
|
|
||
| optimizer: | ||
| type: AdamWithScaler | ||
| lr: 0.01 | ||
|
|
||
| scheduler: | ||
| type: ChainedSchedulerE2E | ||
| acc_grad_iter: 1 | ||
| num_epochs: ${TRAIN.num_epochs} | ||
| warm_up_epochs: 3 | ||
|
|
||
| SYSTEM: | ||
| log_dir: ./logs | ||
| seed: 42 | ||
| GPU: 4 # number of gpus to use | ||
| device: cuda # auto | cuda | cpu | ||
| gpu_id: 0 # device id for single gpu training No newline at end of file |
|
|
||
| DATA: | ||
| dataset_name: SoccerNet | ||
| data_dir: /home/vorajv/opensportslib/SoccerNet/annotations/ |
Comment on lines
+100
to
+109
| step_size: 3 | ||
| gamma: 0.1 | ||
|
|
||
| SYSTEM: | ||
| log_dir: ./logs | ||
| use_seed: false | ||
| seed: 42 | ||
| GPU: 4 | ||
| device: cuda # auto | cuda | cpu | ||
| gpu_id: 0 No newline at end of file |
Comment on lines
+99
to
+107
| save_dir: ./checkpoints_tracking | ||
|
|
||
| SYSTEM: | ||
| log_dir: ./logs | ||
| use_seed: true | ||
| seed: 42 | ||
| GPU: 4 | ||
| device: cuda # auto | cuda | cpu | ||
| gpu_id: 0 No newline at end of file |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improved README.md and re-arranged the structure of the folders (mainly docs files)