Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,49 @@
+
+# Rust Code Dataset
+
+## Dataset Description
+
+This dataset contains Rust functions with their documentation comments extracted from GitHub repositories.
+
+### Features
+
+- `code`: The Rust function code
+- `docstring`: Documentation comment for the function
+- `func_name`: Function name
+- `language`: Programming language (always "rust")
+- `repo`: Source repository name
+- `path`: File path within the repository
+- `url`: GitHub URL to the source file
+- `license`: License of the source code
+
+## Dataset Structure
+
+The dataset contains the following splits:
+        
+- train: 858128 examples
+- validation: 13376 examples
+- test: 18051 examples
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("USERNAME/DATASET_NAME")
+
+# Access the training split
+train_data = dataset["train"]
+
+# Example: Print the first sample
+print(train_data[0])
+```
+
+## Source
+
+This dataset was created by scraping Rust code from GitHub repositories. Each function includes its documentation comment and license information.
+
+## License
+
+This dataset contains code from various repositories with different licenses. Each sample includes its original license information in the `license` field.
+