Update README.md

README.md

@@ -9,4 +9,115 @@ tags:
 pretty_name: Blender Duplicates
 size_categories:
 - 1K<n<10K
----
+---
+# Dataset Card for Dataset Name
+
+Contains reduced description of issues reported at https://projects.blender.org/blender/blender/issues and points to duplicate issues in order to categorize similarity.
+
+This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+
+## Dataset Details
+
+### Dataset Description
+
+Each report has been shortened by removing frequently repeated texts such as **System Information**, **Blender Version**, **Short description of error**.
+This dataset was used to train https://huggingface.co/mano-wii/BAAI_bge-base-en-v1.5-tunned-for-blender-issues
+
+
+
+- **Curated by:** @mano-wii
+- **Funded by:** @mano-wii
+- **Shared by:** @mano-wii
+- **Language(s) (NLP):** English
+- **License:** https://mano-wii-tools.hf.space/api/v1/static/privace.txt
+
+## Uses
+
+With this dataset, we can train a model considering terms and utilities used in Blender and the relation with problems with specific hardware.
+
+### Direct Use
+
+Creation of embeddings for 3D software technical reports
+
+## Dataset Structure
+
+At this dataset we can see the main issue in the first column, unrecognized issues in the second column ('neg') and duplicates in the third column ('pos').
+
+## Dataset Creation
+
+### Curation Rationale
+
+This dataset was created to train a model for creating embeddings to search for semantic similarity of reports in Blender and thus allow the WEB Extension
+[Blender Find Related Issues](https://chromewebstore.google.com/detail/blender-find-related-issu/gppmbbnfhiajghdannflpoieilidjpnf) to work
+
+### Source Data
+
+https://projects.blender.org/blender/blender/issues
+
+#### Data Collection and Processing
+
+The date was automatically collected in Python when fetching reports categorized as duplicates. These reports were then filtered by similarity testing using other AI models.
+
+#### Who are the source data producers?
+
+These reports are produced by Blender users around the world who are interested in reporting bugs in order to improve the quality of the software.
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+[More Information Needed]
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+[More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed]
+
+## Dataset Card Authors [optional]
+
+[More Information Needed]
+
+## Dataset Card Contact
+
+[More Information Needed]