Update dataset card

README.md

@@ -1,16 +1,38 @@
+---
+license: gpl-3.0
+task_categories:
+- token-classification
+language:
+- tl
+size_categories:
+- 1K<n<10K
+pretty_name: TLUnified-NER
+tags:
+- low-resource
+- named-entity-recognition
+---
+
 <!-- SPACY PROJECT: AUTO-GENERATED DOCS START (do not remove) -->
 
 # 🪐 spaCy Project: Dataset builder to HuggingFace Hub
 
-This project contains utility scripts for uploading a dataset to HuggingFace
-Hub.  We want to separate the spaCy dependencies from the loading script, so
-we're parsing the spaCy files independently.
 
-The process goes like this: we download the raw corpus from Google Cloud
-Storage (GCS), convert the spaCy files into a readable IOB format, and parse
-that using our loading script (i.e., `tlunified-ner.py`).
+## Dataset Description
+
+This dataset contains the annotated TLUnified corpora from Cruz and Cheng
+(2021).  It consists of a curated sample of around 7,000 documents for the
+named entity recognition (NER) task.  The majority of the corpus are news
+reports in Tagalog, resembling the domain of the original ConLL 2003.  There
+are three entity types: Person (PER), Organization (ORG), and Location (LOC).
 
-We're also shipping the IOB file so that it's easier to access.
+## About this repository
+
+This repository is a [spaCy project](https://spacy.io/usage/projects) for
+converting the annotated spaCy files into IOB. The process goes like this: we
+download the raw corpus from Google Cloud Storage (GCS), convert the spaCy
+files into a readable IOB format, and parse that using our loading script
+(i.e., `tlunified-ner.py`). We're also shipping the IOB file so that it's
+easier to access.
 
 
 ## 📋 project.yml
@@ -30,6 +52,17 @@ Commands are only re-run if their inputs have changed.
 | `setup-data` | Prepare the Tagalog corpora used for training various spaCy components |
 | `upload-to-hf` | Upload dataset to HuggingFace Hub |
 
+### ⏭ Workflows
+
+The following workflows are defined by the project. They
+can be executed using [`spacy project run [name]`](https://spacy.io/api/cli#project-run)
+and will run the specified commands in order. Commands are only re-run if their
+inputs have changed.
+
+| Workflow | Steps |
+| --- | --- |
+| `all` | `setup-data` &rarr; `upload-to-hf` |
+
 ### 🗂 Assets
 
 The following assets are defined by the project. They can

project.yml

@@ -1,14 +1,20 @@
-title: "Dataset builder to HuggingFace Hub"
+title: "TLUnified-NER Corpus"
 description: |
-  This project contains utility scripts for uploading a dataset to HuggingFace
-  Hub.  We want to separate the spaCy dependencies from the loading script, so
-  we're parsing the spaCy files independently.
 
-  The process goes like this: we download the raw corpus from Google Cloud
-  Storage (GCS), convert the spaCy files into a readable IOB format, and parse
-  that using our loading script (i.e., `tlunified-ner.py`).
+  This dataset contains the annotated TLUnified corpora from Cruz and Cheng
+  (2021).  It consists of a curated sample of around 7,000 documents for the
+  named entity recognition (NER) task.  The majority of the corpus are news
+  reports in Tagalog, resembling the domain of the original ConLL 2003.  There
+  are three entity types: Person (PER), Organization (ORG), and Location (LOC).
 
-  We're also shipping the IOB file so that it's easier to access.
+  ### About this repository
+
+  This repository is a [spaCy project](https://spacy.io/usage/projects) for
+  converting the annotated spaCy files into IOB. The process goes like this: we
+  download the raw corpus from Google Cloud Storage (GCS), convert the spaCy
+  files into a readable IOB format, and parse that using our loading script
+  (i.e., `tlunified-ner.py`). We're also shipping the IOB file so that it's
+  easier to access.
 
 directories: ["assets", "corpus/spacy", "corpus/iob"]
 
@@ -20,6 +26,11 @@ assets:
     description: "Annotated TLUnified corpora in spaCy format with train, dev, and test splits."
     url: "https://storage.googleapis.com/ljvmiranda/calamanCy/tl_tlunified_gold/v${vars.version}/corpus.tar.gz"
 
+workflows:
+  all:
+    - "setup-data"
+    - "upload-to-hf"
+
 commands:
   - name: "setup-data"
     help: "Prepare the Tagalog corpora used for training various spaCy components"
@@ -35,7 +46,7 @@ commands:
   - name: "upload-to-hf"
     help: "Upload dataset to HuggingFace Hub"
     script:
-      - ls
+      - git push
     deps:
       - corpus/iob/train.iob
       - corpus/iob/dev.iob