Skip to content

Commit e575511

Browse files
abidlabsclaude
andauthored
Update contributing documentation (#267)
Co-authored-by: Claude <noreply@anthropic.com>
1 parent 43b721d commit e575511

2 files changed

Lines changed: 19 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,15 @@ The project is organized as follows:
2222

2323
The flow of data is:
2424

25-
> User API (`__init__.py` or `run.py`) → Gradio UI (`ui/`) → SQLite Storage (`sqlite_storage.py`)
25+
> User API (`__init__.py` or `run.py`) → calls the Gradio Client to make changes in the Gradio UI (`ui/`) → logs the data in the SQLite Storage (`sqlite_storage.py`)
2626
2727

2828
## Development Setup
2929

3030
1. Fork and clone the repository
31-
2. Install development dependencies
31+
2. Install Trackio with development dependencies
3232
```bash
33-
pip install -r requirements.txt
34-
pip install pytest ruff
33+
pip install -e .[dev,tensorboard]
3534
```
3635
3. Run tests before submitting changes:
3736
```bash
@@ -49,4 +48,8 @@ The flow of data is:
4948
3. Update documentation if necessary
5049
4. Submit a pull request with a clear description of your changes
5150

52-
Thank you for contributing to Trackio!
51+
Thank you to all contributors to Trackio!
52+
53+
<p align="center">
54+
<img src="https://contrib.rocks/image?repo=gradio-app/trackio" />
55+
</p>

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,17 @@ MIT License
183183

184184
The complete documentation and API reference for each version fo Trackio can be found at: https://huggingface.co/docs/trackio/index
185185

186+
## Contribute
187+
188+
We welcome contributions to Trackio! Whether you're fixing bugs, adding features, or improving documentation, your contributions help make Trackio btter for the entire machine learning community.
189+
190+
<p align="center">
191+
<img src="https://contrib.rocks/image?repo=gradio-app/trackio" />
192+
</p>
193+
194+
To start contributing, see our [Contributing Guide](CONTRIBUTING.md).
195+
196+
186197
## Pronunciation
187198

188199
Trackio is pronounced TRACK-yo, as in "track yo' experiments"

0 commit comments

Comments
 (0)