Skip to content

Commit 4db1e09

Browse files
CopilotRitesh313
andcommitted
Add note to update_readme.py script about new documentation structure
Co-authored-by: Ritesh313 <36135489+Ritesh313@users.noreply.github.com>
1 parent 64e1dc3 commit 4db1e09

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

scripts/update_readme.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
"""
33
Simple script to update README.md with current dataset statistics using only pandas.
44
5+
⚠️ NOTE: This script generates the OLD README format with extensive details.
6+
The current README is simplified and focuses on essentials only.
7+
Detailed documentation is now in the docs/ directory.
8+
9+
If you need to update statistics in the README, manually update the numbers in:
10+
- README.md (main statistics)
11+
- docs/training.md (baseline results)
12+
- docs/visualization.md (if needed)
13+
514
Usage:
615
python scripts/update_readme.py --csv /path/to/data.csv --readme /path/to/README.md
716
"""

0 commit comments

Comments
 (0)