Upload README.md with huggingface_hub

README.md

@@ -6,4 +6,51 @@ tags:
 - education
 - spaced-repetition
 - memory
----
+---
+
+# Student Memory Logs Dataset
+
+This dataset contains student memory logs for spaced repetition learning systems.
+
+## Dataset Files
+
+- `opensource_dataset.tsv`: Main dataset file
+- `opensource_dataset_difficulty.tsv`: Difficulty-related data
+- `opensource_dataset_forgetting_curve.tsv`: Forgetting curve data
+- `opensource_dataset_offset.tsv`: Offset-related data
+
+## Uploading to Hugging Face
+
+### Prerequisites
+
+1. Install required dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+2. Login to Hugging Face (if not already logged in):
+```bash
+huggingface-cli login
+```
+
+### Upload Dataset
+
+Run the upload script with your Hugging Face repository ID:
+
+```bash
+python upload_to_hf.py --repo-id <your-username>/student-memory-logs
+```
+
+For a private repository:
+```bash
+python upload_to_hf.py --repo-id <your-username>/student-memory-logs --private
+```
+
+If you need to use a specific token:
+```bash
+python upload_to_hf.py --repo-id <your-username>/student-memory-logs --token <your-token>
+```
+
+## License
+
+This dataset is licensed under CC-BY-NC-4.0 (Creative Commons Attribution-NonCommercial 4.0 International).