Skip to content

Modified documentation #1

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Modified documentation #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ timeseriesgym grade-sample path/to/submission.csv amp-parkinsons-disease-progres
```bash
# Clone the repository
git clone https://github.com/your-org/timeseriesgym.git
cd timeseriesgym
cd TimeSeriesGym

# Install the package
pip install -e .
Expand Down
4 changes: 2 additions & 2 deletions documentation/adding_new_challenges.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TimeSeriesGym supports competitions from various sources beyond Kaggle, includin
Create a directory for your competition:

```bash
mkdir -p /timeseriesgym/competitions/<competition-id>
mkdir -p timeseriesgym/competitions/<competition-id>
```

> **Important**: Choose a clear, descriptive `competition-id` that follows the naming convention of other competitions (kebab-case recommended).
Expand Down Expand Up @@ -100,7 +100,7 @@ If programmatic download is not feasible:

1. Download the dataset files manually
2. Create a zip archive containing all necessary files
3. Place the zip file at `/timeseriesgym/competitions/<competition-id>/<competition-id>.zip`
3. Place the zip file at `timeseriesgym/competitions/<competition-id>/<competition-id>.zip`

> **Important**: When downloading data manually, be consistent with file naming and organization to ensure reproducibility.

Expand Down
6 changes: 3 additions & 3 deletions documentation/adding_new_kaggle_challenge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Adding a new competition requires several components:
Create a new directory for your competition in the TimeSeriesGym structure:

```bash
mkdir -p /timeseriesgym/competitions/<competition-id>
mkdir -p timeseriesgym/competitions/<competition-id>
```

> **Important**: The directory name must match the competition ID exactly. You can find the competition ID from the Kaggle dataset download command:
Expand Down Expand Up @@ -136,7 +136,7 @@ Make sure your grading function implements the exact same metric used by the Kag
Create an empty `leaderboard.csv` file, which will be populated automatically:

```bash
touch /timeseriesgym/competitions/<competition-id>/leaderboard.csv
touch timeseriesgym/competitions/<competition-id>/leaderboard.csv
```

Then download the leaderboard data:
Expand Down Expand Up @@ -350,7 +350,7 @@ Where `custom.txt` is a file containing only your competition ID.
After completion, your competition directory should look like:

```
/timeseriesgym/competitions/<competition-id>/
timeseriesgym/competitions/<competition-id>/
├── config.yaml
├── description.md
├── grade.py
Expand Down