Skip to main content

Corpus of Annual Reports in Japan

Project description

CoARiJ: Corpus of Annual Reports in Japan

PyPI version Build Status codecov

We organized Japanese financial reports to encourage applying NLP techniques to financial analytics.

Dataset

You can download dataset by command line tool.

pip install coarij

Please refer the usage by -- (using fire).

coarij --

Example command.

# Download raw file version dataset of 2014.
coarij download --kind F --year 2014

# Extract business.overview_of_result part of TIS.Inc (sec code=3626).
coarij parse business.overview_of_result --sec_code 3626

# Tokenize text by Janome (`janome` or `sudachi` is supported).
pip install janome
coarij tokenize --tokenizer janome

# Show tokenized result (words are separated by \t).
head -n 5 data/processed/2014/docs/S100552V_business_overview_of_result_tokenized.txt
1             業績                概要    (       1       )               業績
当      連結    会計    年度    における        我が国  経済               消費    税率    引上げ        伴う    駆け込み        需要          反動         海外    景気    動向    に対する        先行き  懸念          から   弱い    動き                られ    まし                      企業   収益          改善          により  全体  ...

You can use Ledger to select your necessary file from overall CoARiJ dataset.

from coarij.storage import Storage


storage = Storage("your/data/directory")
ledger = storage.download_ledger()
collected = ledger.collect(edinet_code="E00021")

Raw dataset file

The corpora are separated to each financial years.

fiscal_year Raw file version (F) Text extracted version (E)
2014 .zip (9.3GB) .zip (269.9MB)
2015 .zip (9.8GB) .zip (291.1MB)
2016 .zip (10.2GB) .zip (334.7MB)
2017 .zip (9.1GB) .zip (309.4MB)
2018 .zip (10.5GB) .zip (260.9MB)

Statistics

fiscal_year number_of_reports has_csr_reports has_financial_data has_stock_data
2014 3,724 92 3,583 3,595
2015 3,870 96 3,725 3,751
2016 4,066 97 3,924 3,941
2017 3,578 89 3,441 3,472
2018 3,513 70 2,893 3,413

Content

Raw file version (--kind F)

The structure of dataset is following.

chakki_esg_financial_{year}.zip
└──{year}
     ├── documents.csv
     └── docs/

docs includes XBRL and PDF file.

  • XBRL file of annual reports (files are retrieved from [EDINET]).
  • PDF file of CSR reports (additional content).

documents.csv has metadata like following.

  • edinet_code: E0000X
  • filer_name: XXX株式会社
  • fiscal_year: 201X
  • fiscal_period: FY
  • doc_path: docs/S000000X.xbrl
  • csr_path: docs/E0000X_201X_JP_36.pdf

Text extracted version (--kind E)

Text extracted version includes txt files that match each part of an annual report.
The extracted parts are defined at edinet-python.

chakki_esg_financial_{year}_extracted.zip
└──{year}
     ├── documents.csv
     └── docs/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coarij-0.2.1.tar.gz (10.7 kB view details)

Uploaded Source

File details

Details for the file coarij-0.2.1.tar.gz.

File metadata

  • Download URL: coarij-0.2.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.1

File hashes

Hashes for coarij-0.2.1.tar.gz
Algorithm Hash digest
SHA256 93fbdc2a4bbb0d0432e71d1adea1986da6baecfbcd4b0d9ae8b7e5251ecf08f9
MD5 137f4d40d630dcc084e8eff938423863
BLAKE2b-256 847347ce2973a8d8d6a57ee9ff9e8d42352890106942b4e014fea13aaae77b51

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page