README.md

---
language: ja
license: cc-by-4.0
size_categories:
  - 100K<n<1M
configs:
- config_name: current
  data_files:
  - split: train
    path: "current/train.jsonl"
  - split: validation
    path: "current/validation.jsonl"
  - split: test
    path: "current/test.jsonl"
- config_name: future
  data_files:
  - split: train
    path: "future/train.jsonl"
  - split: validation
    path: "future/validation.jsonl"
  - split: test
    path: "future/test.jsonl"
---


# economy-watchers-survey
[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 dataset for tasks is [retarfi/economy-watchers-survey-evaluation](https://huggingface.co/datasets/retarfi/economy-watchers-survey-evaluation). 


[景気ウォッチャー調査](https://www5.cao.go.jp/keizai3/watcher/watcher_menu.html)のデータを自動更新・整形・抽出を行います。  
自動更新はGitHub Actionsによって月次で行われます。  
タスク用のデータセットは[retarfi/economy-watchers-survey-evaluation](https://huggingface.co/datasets/retarfi/economy-watchers-survey-evaluation)から利用可能です。  


## Data detail
Please refer to the following papers for the data detail.    
データの詳細は、以下の論文を参照してください。

- English paper: https://arxiv.org/abs/2407.14727
- GitHub: https://github.com/retarfi/economy-watchers-survey

For citation:
```
@preprint{suzuki2024-ews,
  title={{Economy Watchers Survey provides Datasets and Tasks for Japanese Financial Domain}}, 
  author={Masahiro Suzuki and Hiroki Sakaji},
  year={2024},
  doi={10.48550/arXiv.2407.14727}, 
}
```


## How to use


```py
# datasets >= 2.15.0 is required
from datasets import load_dataset
ds = load_dataset(
    "retarfi/economy-watchers-survey",
    name="current",
    revision="2024.06.0",
    split="validation",
)
```
The `name` can be selected from `current` (current business cycle) or `future` (future business cycle).  
If `revision` is not specified, the latest data is read.  
If `split` is specified, the data is read in `datasets.Dataset` format, otherwise in `datasets.DatasetDict` format.


`name`は`"current"`(現状の景気判断)または`"future"`(先行きの景気判断)から選択できます。  
`revision`を指定しない場合、最新のデータが読み込まれます。  
`split`を指定した場合は`datasets.Dataset`形式で、指定しない場合は`datasets.DatasetDict`形式で読み込まれます。


## LICENSE
CC-BY 4.0