Upload README.md with huggingface_hub

README.md

@@ -1,31 +1,116 @@
 ---
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: schematic
-    dtype: string
-  - name: image
-    dtype: image
-  - name: components_used
-    list: string
-  - name: json
-    dtype: string
-  - name: yaml
-    dtype: string
-  - name: name
-    dtype: string
-  - name: description
-    dtype: string
-  - name: type
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 15420182098
-    num_examples: 84470
-  download_size: 6666345413
-  dataset_size: 15420182098
+license: cc-by-4.0
+task_categories:
+- text-generation
+- image-to-text
+- text-to-image
+language:
+- en
+tags:
+- electronics
+- schematics
+- kicad
+- hardware
+- pcb
+- circuit-design
+- engineering
+size_categories:
+- 10K<n<100K
 ---
+
+![Open Schematics](open-schematics.png)
+
+# Open Schematics Dataset
+
+A comprehensive dataset of electronic schematics from hardware projects. This dataset is designed for training AI models on circuit design, component recognition, and hardware engineering tasks.
+
+## Dataset Description
+
+This dataset contains electronic schematic files along with their visual representations, component information, and metadata from various hardware projects.
+
+### Dataset Structure
+
+Each record in the dataset contains:
+
+- **schematic**: Raw schematic file content (primarily `.kicad_sch` format)
+- **image**: PNG rendering of the schematic
+- **components_used**: List of electronic components used in the schematic
+- **json**: JSON representation of the schematic structure
+- **yaml**: YAML representation of the schematic metadata
+- **name**: Project name
+- **description**: Project description
+- **type**: File extension/format (e.g., `.kicad_sch`)
+
+### Data Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `schematic` | string | Raw schematic file content |
+| `image` | image | Visual rendering of the schematic (PNG) |
+| `components_used` | list[string] | Electronic components used in the design |
+| `json` | string | JSON representation of schematic structure |
+| `yaml` | string | YAML metadata of the schematic |
+| `name` | string | Name of the project |
+| `description` | string | Description of the project |
+| `type` | string | Schematic file format/extension |
+
+## Dataset Creation
+
+### Source Data
+
+The dataset is compiled from hardware projects, with schematics created using EDA software.
+
+### Data Collection
+
+Schematics were collected from publicly available hardware repositories and processed to extract:
+- Raw schematic files
+- Visual representations (PNG images)
+- Component lists
+- Structured metadata (JSON/YAML)
+
+### Data Processing
+
+- Empty schematics (without components or symbols) are filtered out
+- Component names are extracted from library symbols
+- Images are generated for visual representation
+- Multiple format representations (raw, JSON, YAML) are provided for flexibility
+
+## Use Cases
+
+This dataset can be used for:
+
+- **Circuit Design AI**: Training models to generate or understand electronic schematics
+- **Component Recognition**: Identifying electronic components from schematic diagrams
+- **Design Assistance**: Building tools to help engineers with circuit design
+- **Documentation Generation**: Automatically generating documentation from schematics
+- **Design Validation**: Training models to detect errors or suggest improvements
+- **Educational Tools**: Creating interactive learning systems for electronics education
+
+## Limitations
+
+- Dataset primarily contains `.kicad_sch` format schematics
+- Quality and complexity of schematics vary across projects
+- Some projects may have incomplete metadata
+- Component naming conventions may vary between projects
+
+## License
+
+This dataset is released under the Creative Commons Attribution 4.0 International (CC-BY-4.0) license. Please ensure you comply with the original licenses of the source projects when using this data.
+
+## Citation
+
+If you use this dataset in your research or projects, please cite:
+
+```bibtex
+@dataset{open_schematics_2025,
+  title={Open Schematics: A Dataset of Electronic Schematics from Hardware Projects},
+  author={bshada},
+  year={2025},
+  publisher={Hugging Face},
+  howpublished={\url{https://huggingface.co/datasets/bshada/open-schematics}}
+}
+```
+
+## Contact
+
+For questions, issues, or contributions, please open an issue on the dataset repository.