diff --git a/README.md b/README.md index 29b1d6f..bef8ddc 100644 --- a/README.md +++ b/README.md @@ -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 . diff --git a/documentation/adding_new_challenges.md b/documentation/adding_new_challenges.md index 7f22450..394f935 100644 --- a/documentation/adding_new_challenges.md +++ b/documentation/adding_new_challenges.md @@ -15,7 +15,7 @@ TimeSeriesGym supports competitions from various sources beyond Kaggle, includin Create a directory for your competition: ```bash -mkdir -p /timeseriesgym/competitions/ +mkdir -p timeseriesgym/competitions/ ``` > **Important**: Choose a clear, descriptive `competition-id` that follows the naming convention of other competitions (kebab-case recommended). @@ -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//.zip` +3. Place the zip file at `timeseriesgym/competitions//.zip` > **Important**: When downloading data manually, be consistent with file naming and organization to ensure reproducibility. diff --git a/documentation/adding_new_kaggle_challenge.md b/documentation/adding_new_kaggle_challenge.md index 5593ea8..fbe11f8 100644 --- a/documentation/adding_new_kaggle_challenge.md +++ b/documentation/adding_new_kaggle_challenge.md @@ -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/ +mkdir -p timeseriesgym/competitions/ ``` > **Important**: The directory name must match the competition ID exactly. You can find the competition ID from the Kaggle dataset download command: @@ -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//leaderboard.csv +touch timeseriesgym/competitions//leaderboard.csv ``` Then download the leaderboard data: @@ -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// +timeseriesgym/competitions// ├── config.yaml ├── description.md ├── grade.py