zip added

Author: cmanzo

README.md

@@ -1 +1,60 @@
-# particle_dataset
+# Particle Dataset
+
+Welcome to the GitHub page of DeepTrackAI's Particle dataset. The Particle dataset is a collection of movies of optically-trapped particles used for training and evaluating deep learning models.
+
+## Description
+
+The Particle dataset contains 2 movies in avi format. Each image is a grayscale picture of a digit, and the associated label is the digit value (from 0 to 9).
+
+- **Dataset Size**: 2 movies
+- **Frame Number**: frames per movie
+- **Frame Size**: 28x28 pixels
+- **Color**: Grayscale
+
+## Usage
+
+To use the Particle dataset in your project:
+
+1. Clone this repository to your local machine.
+2. Import the dataset into your machine learning framework of choice.
+3. Train or evaluate your models using the dataset.
+
+### Download via Command Line
+
+To clone the repository and access the Particle dataset:
+
+```bash
+git clone -b mnist github.com/DeepTrackAI/Particle_deeplay
+cd Particle_deeplay
+```
+
+### Download Programmatically in Python
+
+If you want to load the dataset directly into a Python script or Jupyter notebook:
+
+```python
+import requests
+from io import BytesIO
+from zipfile import ZipFile
+
+# URL to the repository (modify this if the dataset is hosted in a specific location or file)
+DATASET_URL = 'https://github.com/DeepTrackAI/Particle_dataset/raw/main/mnist.zip'
+
+response = requests.get(DATASET_URL)
+with ZipFile(BytesIO(response.content)) as z:
+ z.extractall()
+
+# Now you can load the dataset using your preferred library, e.g., deeplay, PyTorch, TensorFlow.
+```
+
+## Acknowledgements
+
+- The Particle dataset was originally created by ?????.
+
+## License
+
+The Particle dataset is made available under the terms of the [Creative Commons Attribution-Share Alike 3.0 license](https://creativecommons.org/licenses/by-sa/3.0/).
+
+## Contributing
+
+If you find any issues with the dataset or have suggestions for improvements, please open an issue or submit a pull request.