Creat README.md

README.md

@@ -0,0 +1,144 @@
+---
+license: apache-2.0
+task_categories:
+- translation
+- summarization
+- text2text-generation
+language:
+- ar
+- en
+tags:
+- legal
+- finance
+- medical
+- webdataset
+pretty_name: BrainData
+size_categories:
+- n>1T
+---
+
+# Dataset Card for BrainData
+
+<!-- Provide a quick summary of the dataset. -->
+
+This dataset card provides detailed information about the BrainData dataset. 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
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+BrainData is a comprehensive dataset designed for multiple NLP tasks including translation, summarization, and text-to-text generation. It encompasses a variety of domains such as legal, finance, and medical, with content available in both Arabic and English. This extensive dataset is ideal for training robust multilingual models.
+
+- **Curated by:** Dr. Mohamed El Fadil
+- **Funded by:** BRAINSAIT LTD
+- **Shared by:** Dr. Mohamed El Fadil
+- **Language(s) (NLP):** Arabic, English
+- **License:** Apache-2.0
+
+### Dataset Sources [optional]
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** [BrainData GitHub Repository](https://github.com/brainsait/dataset)
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+BrainData can be used for training models in translation, summarization, and text generation. It is particularly useful for applications in the legal, finance, and medical sectors, where multilingual support is required.
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+The dataset is not suitable for tasks unrelated to text processing, such as image recognition or speech-to-text. Additionally, it should not be used for generating inappropriate or harmful content.
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+The dataset includes text data in both Arabic and English, covering multiple domains. It is structured to support easy access and processing, with clear separations between different task categories and languages.
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+BrainData was created to address the need for high-quality multilingual datasets in the fields of legal, finance, and medical text processing. It aims to facilitate the development of advanced NLP models that can operate across different languages and domains.
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+The source data includes legal documents, financial reports, medical records, and web data, ensuring a diverse and representative sample of text for each domain.
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+Data was collected from reputable sources in the legal, finance, and medical fields. It underwent thorough filtering and normalization to ensure consistency and quality. Tools such as Python's NLTK and SpaCy libraries were used for text preprocessing.
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+The source data was produced by professionals and organizations in the legal, finance, and medical sectors, ensuring authoritative and accurate content.
+
+### Annotations [optional]
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### 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. -->
+
+Annotations were performed by domain experts using tools like Prodigy and Labelbox. Guidelines were provided to ensure consistency, and inter-annotator agreement was regularly checked to maintain quality.
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+The annotators were professionals with expertise in legal, finance, and medical fields, ensuring high-quality and accurate annotations.
+
+#### 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. -->
+
+The dataset contains sensitive information, particularly in the medical and financial domains. All personal identifiers have been removed or anonymized to protect privacy.
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+The dataset may contain biases inherent to the source data, such as regional or institutional biases. Users should be aware of these limitations and consider them when developing models.
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users should perform bias analysis and fairness checks when using the dataset, especially for critical applications. Regular updates and retraining with new data are recommended to mitigate biases.
+
+## 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:**
+
+```bibtex
+@misc{braindata2024dataset,
+  title={BrainData: A Multilingual Dataset for Legal, Finance, and Medical Text Processing},
+  author={El Fadil, Mohamed and BrainSAIT Team},
+  year={2024},
+  url={https://github.com/brainsait/dataset}
+}