Create README.md

README.md

@@ -0,0 +1,107 @@
+---
+task_categories:
+- text-classification
+- token-classification
+language:
+- en
+tags:
+- biology
+- nlp
+- ner
+pretty_name: CellFinder CoNLL
+size_categories:
+- 1K<n<10K
+---
+
+# Dataset Card for CellFinder CoNLL
+
+<!-- Provide a quick summary of the dataset. -->
+
+This data was processed into the CoNLL format, following a direct download of a Humboldt university of Berlin resource.
+
+For clarity, this is the same data is in _OTAR3088/CellFinder-cleaned_BRAT_, in another format.
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+From data source _https://www.informatik.hu-berlin.de/de/forschung/gebiete/wbi/resources/cellfinder/_, this data is described as follows:
+
+**- - - - - - -**
+
+The first version of our corpus is composed of 10 full text documents containing more than 2,100 sentences, 65,000 tokens and 5,200 annotations for entities.
+The corpus has been annotated with six types of entities (_anatomical parts, cell components, cell lines, cell types, genes/protein and species_) with an overall inter-annotator agreement around 80%.
+
+**- - - - - - -**
+
+- **Curated by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed]
+
+### Dataset Sources
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Link:** _https://www.informatik.hu-berlin.de/de/forschung/gebiete/wbi/resources/cellfinder/_
+- **Paper:** Mariana Neves, Alexander Damaschun, Andreas Kurtz, Ulf Leser. Annotating and evaluating text for stem cell research. Third Workshop on Building and Evaluation Resources for Biomedical Text Mining (BioTxtM 2012) at Language Resources and Evaluation (LREC) 2012.
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+We utilised this dataset to train a NER model to annotate the entity types detailed by the authors of this dataset.
+
+In turn this data became part of a larger dataset for our group.
+
+We copied this format of the data to our huggingface project for easier ingestion into our NER-model production pipeline. 
+
+
+## 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. -->
+
+This data is stored in the ConLL format, with each article, identified through it's PMCID, annotated via a _.conll_ file.
+
+Annotations appear as shown in the following example:
+
+**- - - - - - -**
+
+of O
+
+human B-Species
+
+embryonic I-CellType
+
+stem I-CellType
+
+cell I-CellType
+
+(hESC) O
+
+lines O
+
+**- - - - - - -**
+
+With terms annotated in the IOB format - Beginning, Inside, Outside
+
+### 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
+
+Mariana Neves, Alexander Damaschun, Andreas Kurtz, Ulf Leser. Annotating and evaluating text for stem cell research. Third Workshop on Building and Evaluation Resources for Biomedical Text Mining (BioTxtM 2012) at Language Resources and Evaluation (LREC) 2012.
+
+
+## Dataset Card Authors
+
+Christine Withers - _https://huggingface.co/christine-withers_
+
+## Dataset Card Contact
+
+Christine Withers - _https://huggingface.co/christine-withers_