Update README.md

README.md

@@ -65,117 +65,66 @@ The dataset is a collection of Czech texts annotated with named entities.
 The original CNEC 2.0 dataset contains 8993 Czech sentences with 35220 Czech named entities (train + validation + test).
 The original corpus uses 58 entity types.
 The extended version uses only 7 entity types and one additional type for non-entities:
-- 'O' = Outside of a named entity
-- 'B-A' = Beginning of a complex address number (Postal code, street number, even phone number)
-- 'I-A' = Inside of a number in the address
-- 'B-G' = Beginning of a geographical name
-- 'I-G' = Inside of a geographical name
-- 'B-I' = Beginning of an institution name
-- 'I-I' = Inside of an institution name
-- 'B-M' = Beginning of a media name (email, server, website, tv series, etc.)
-- 'I-M' = Inside of a media name
-- 'B-O' = Beginning of an artifact name (book, old movies, etc.)
-- 'I-O' = Inside of an artifact name
-- 'B-P' = Beginning of a person's name
-- 'I-P' = Inside of a person's name
-- 'B-T' = Beginning of a time expression
-- 'I-T' = Inside of a time expression
+```
+Description of entities:
+'O' = Outside of a named entity
+'B-A' = Beginning of a complex address number (Postal code, street number, even phone number)
+'I-A' = Inside of a number in the address
+'B-G' = Beginning of a geographical name
+'I-G' = Inside of a geographical name
+'B-I' = Beginning of an institution name
+'I-I' = Inside of an institution name
+'B-M' = Beginning of a media name (email, server, website, tv series, etc.)
+'I-M' = Inside of a media name
+'B-O' = Beginning of an artifact name (book, old movies, etc.)
+'I-O' = Inside of an artifact name
+'B-P' = Beginning of a person's name
+'I-P' = Inside of a person's name
+'B-T' = Beginning of a time expression
+'I-T' = Inside of a time expression
+
+Labels:
+'0': O
+'1': B-A
+'2': I-A
+'3': B-G
+'4': I-G
+'5': B-I
+'6': I-I
+'7': B-M
+'8': I-M
+'9': B-O
+'10': I-O
+'11': B-P
+'12': I-P
+'13': B-T
+'14': I-T
+```
 
 ### Dataset Sources [optional]
 
 <!-- Provide the basic links for the dataset. -->
 
 - **Repository:** http://hdl.handle.net/11234/1-3493
-- **Paper [optional]:** https://link.springer.com/chapter/10.1007/978-3-642-40585-3_20
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the dataset is intended to be used. -->
-This is a dataset created for fine-tuning LMs for the NER task
-
-### Direct Use
-
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+- **Paper:** https://link.springer.com/chapter/10.1007/978-3-642-40585-3_20
 
 ## 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]
+The dataset is formated in a CONLL format, use the ner_tags for tokenization, spans and langs is only a surplus.
 
 ## 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?
 
 "http://hdl.handle.net/11234/1-3493"
 
-[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:**
 
+ ```
  @misc{11234/1-3493,
  title = {{CoNLL}-based Extended Czech Named Entity Corpus 2.0},
  author = {Konkol, Michal and Konop{\'{\i}}k, Miloslav and {\v S}ev{\v c}{\'{\i}}kov{\'a}, Magda and {\v Z}abokrtsk{\'y}, Zden{\v e}k and Strakov{\'a}, Jana and Straka, Milan},
@@ -191,6 +140,7 @@ Users should be made aware of the risks, biases and limitations of the dataset.
  note = {{LINDAT}/{CLARIAH}-{CZ} digital library at the Institute of Formal and Applied Linguistics ({{\'U}FAL}), Faculty of Mathematics and Physics, Charles University},
  copyright = {Attribution-{NonCommercial}-{ShareAlike} 3.0 Unported ({CC} {BY}-{NC}-{SA} 3.0)},
  year = {2014} }
+```
 
 **APA:**