Update README.md

README.md

@@ -1,3 +1,157 @@
----
-license: mit
----
+---
+license: mit
+task_categories:
+- text-generation
+language:
+- en
+tags:
+- pubmed embedding
+size_categories:
+- 100M<n<1B
+---
+# PubMed Embeddings Dataset
+
+This dataset contains embeddings generated from the PubMed dataset, which can be found at https://huggingface.co/datasets/ncbi/pubmed. The embeddings were created using the NeuML/pubmedbert-base-embedding model.
+
+## Dataset Structure
+
+Each line in the dataset represents a single embedding in the form of a list. The format for each entry is defined as follows:
+
+```python
+node.id_ = f"node-{tpubmed}-{idx}"
+node.metadata["title"] = ttitle
+node.metadata["author"] = firstAuthor
+node.metadata["pubmed"] = tpubmed
+node.metadata["date"] = tdate
+node.metadata["key"] = tpubmed
+node.metadata["source"] = "Pubmed"
+```
+
+- `node.id_`: A unique identifier for each node, formatted as `node-{tpubmed}-{idx}`, where `tpubmed` is the PubMed ID and `idx` is the index of the entry.
+- `node.metadata["title"]`: The title of the PubMed article.
+- `node.metadata["author"]`: The first author of the PubMed article.
+- `node.metadata["pubmed"]`: The PubMed ID of the article.
+- `node.metadata["date"]`: The publication date of the article.
+- `node.metadata["key"]`: The PubMed ID of the article (same as `node.metadata["pubmed"]`).
+- `node.metadata["source"]`: The source of the data, which is always "Pubmed".
+
+## Usage
+
+To use this dataset, you can load it into your preferred data processing library or tool. Each line in the dataset represents a single embedding, and the metadata associated with each embedding can be accessed using the keys defined in the format above.
+
+## Original Data Source
+
+The original data used to create these embeddings can be found at https://huggingface.co/datasets/ncbi/pubmed. Please refer to the documentation and license of the original dataset for more information on its contents and usage.
+
+## Embedding Model
+
+The embeddings in this dataset were generated using the NeuML/pubmedbert-base-embedding model. For more information on the model and its performance, please refer to the model's documentation.
+
+
+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).
+
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+[More Information Needed]
+
+
+## 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. -->
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+[More Information Needed]
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### 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. -->
+
+[More Information Needed]
+
+#### 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. -->
+
+[More Information Needed]
+
+### 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. -->
+
+[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]