Update README.md

README.md

@@ -1,3 +1,49 @@
----
-license: cc-by-4.0
----
+---
+language: ja
+license: cc-by-4.0
+task_categories:
+  - text-classification
+size_categories:
+  - 100K<n<1M
+---
+
+
+# economy-watchers-survey-evaluation
+[Economy Watchers Survey](https://www5.cao.go.jp/keizai3/watcher-e/index-e.html) data.  
+It is automatically updated by GitHub Actions as the economy watcher is updated.  
+The original dataset is [retarfi/economy-watchers-survey](https://huggingface.co/datasets/retarfi/economy-watchers-survey). 
+Please refer to the following GitHub for the data acquisition and filtering process.    
+GitHub: https://github.com/retarfi/economy-watchers-survey
+
+[景気ウォッチャー調査](https://www5.cao.go.jp/keizai3/watcher/watcher_menu.html)をタスク用に整形したデータです。  
+元データは[retarfi/economy-watchers-survey](https://huggingface.co/datasets/retarfi/economy-watchers-survey)から利用可能です。  
+自動更新はGitHub Actionsによって月次で行われます。  
+タスク用のデータセットは[retarfi/economy-watchers-survey-evaluation](https://huggingface.co/datasets/retarfi/economy-watchers-survey-evaluation)から利用可能です。  
+データ取得やフィルタリングのプロセスは以下のGitHubをご参照ください。  
+GitHub: https://github.com/retarfi/economy-watchers-survey
+
+
+
+## How to use
+
+
+```py
+from datasets import load_dataset
+ds = load_dataset(
+    "retarfi/economy-watchers-survey-evaluation",
+    name="sentiment",
+    ews_version="2024.06.0",
+    split="validation",
+)
+```
+The `name` can be selected from `sentiment`, `domain`, or `reason`.  
+If `ews_version` is not specified, the latest data will be read.  
+If `split` is specified, the data is read in `datasets.Dataset` format, otherwise in `datasets.DatasetDict` format.
+
+`name`は`sentiment`、`domain`、`reason`から選択できます。  
+`ews_version`を指定しない場合、最新のデータが読み込まれます。  
+`split`を指定した場合は`datasets.Dataset`形式で、指定しない場合は`datasets.DatasetDict`形式で読み込まれます。
+
+
+## LICENSE
+CC-BY 4.0