Update README.md

README.md

@@ -1,3 +1,105 @@
----
-license: mit
----
+---
+license: mit
+language:
+- en,
+tags:
+- legal
+- patents
+pretty_name: WPI_Month_Kind_Subset
+size_categories:
+- 10K<n<100K
+---
+# WPI_Month_Kind Dataset
+
+![CLEFIP-2011](https://huggingface.co/datasets/amylonidis/PatClass2011/resolve/main/CLEFIP2011.png)
+
+## Dataset Summary
+
+The **WPI_Month_Kind** dataset is a comprehensive collection of approximately 70.000 patent documents from the WPI Test Collection, including only EPO patents,
+proportionate to month and kind fields. For example if the patents with kind code A2 for the month of July correspond to the 10 % of the total patents on the WPI collection 
+then the patents with kind code A2 for the month of July on the custom subset will also correspond to 10 % of the total patents in the subset. 
+Each entry on the dataset encompasses detailed metadata and is structured to facilitate research in patent classification and information retrieval
+## Languages
+
+The dataset contains English text.
+
+## Domain
+
+Patents (intellectual property).
+
+## Dataset Curators
+
+The dataset was created by Eleni Kamateri and Tasos Mylonidis
+
+## Dataset Structure
+
+The dataset consists of a single CSV file that holds all the data.
+In total, there are 17 data fields in the CSV file.
+ 
+
+### Data Fields
+
+The dataset is provided in CSV format and includes the aforementioned fields
+
+- `ucid`: Unique identifier for the patent document.
+- `kind`: Kind code indicating the type of patent document.
+- `lang`: Language of the patent document.
+- `date`: Publication date of the patent.
+- `main_code`: Primary classification code assigned to the patent.
+- `further_codes`: Additional classification codes.
+- `ipcr_codes`: International Patent Classification codes.
+- `cpc_codes`: Cooperative Patent Classification codes.
+- `abstract_en`: Boolean field for existence of English abstract.
+- `description_en`:Boolean field for existence of English description.
+- `claims_en`: Boolean field for existence of English claims.
+- `abstract_fr`: Boolean field for existence of French abstract.
+- `description_fr`:Boolean field for existence of French description.
+- `claims_fr`: Boolean field for existence of French claims.
+- `abstract_de`: Boolean field for existence of German abstract.
+- `description_de`:Boolean field for existence of German description.
+- `claims_de`: Boolean field for existence of German claims.
+
+## Usage
+
+## Loading the Dataset
+
+### Full
+
+To load the complete dataset using the Hugging Face `datasets` library:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("amylonidis/WPI_Tasos_Vertical", data_files='data/wpi_tasos_vertical.csv')
+```
+
+This will load the dataset into a `DatasetDict` object, please make sure you have enough disk space.
+
+## Google Colab Analytics
+
+
+You can also use the following Google Colab notebooks to explore Analytics that were performed to the dataset.
+
+
+- [Dates Analytics](https://colab.research.google.com/drive/1teUGvbTb3pUD1fsiyYN5zKb-HyqaSJhb?usp=sharing)
+
+
+## Dataset Creation
+
+### Source Data
+
+The  dataset aggregates the patent documents from the WPI Test Collection, only for EPO patents using this parsing script:  [Extract Dataset](https://colab.research.google.com/drive/1X45i3XM6GKXcQXDvRXATDbTxYN6WpCy1?usp=sharing)
+
+### Annotations
+
+The dataset does not contain any human-written or computer-generated annotations beyond those produced by patent documents of the Source Data.
+
+## Licensing Information
+
+This dataset is distributed under the [MIT License](https://opensource.org/licenses/MIT). Users are free to use, modify, and distribute the dataset, provided that the original authors are credited.
+
+## Citation
+
+If you utilize the WPI_Month_Kind dataset in your research or applications, please cite it appropriately.
+
+---