OpenAlex / README.md
Mearman's picture
fix: restore curated metadata dropped by generator (papers/arXiv, creators, source_datasets)
ef02eff verified
|
Raw
History Blame Contribute Delete
20 kB
---
configs:
- config_name: authors__author_affiliations
data_files:
- split: train
path: "data/authors/affiliations/*.parquet"
- config_name: authors__author_main
data_files:
- split: train
path: "data/authors/main/*.parquet"
- config_name: authors__author_counts_by_year
data_files:
- split: train
path: "data/authors/counts_by_year/*.parquet"
- config_name: authors__author_display_name_alternatives
data_files:
- split: train
path: "data/authors/display_name_alternatives/*.parquet"
- config_name: authors__author_external_ids
data_files:
- split: train
path: "data/authors/external_ids/*.parquet"
- config_name: authors__author_last_known_institutions
data_files:
- split: train
path: "data/authors/last_known_institutions/*.parquet"
- config_name: authors__author_sources
data_files:
- split: train
path: "data/authors/sources/*.parquet"
- config_name: authors__author_topic_share
data_files:
- split: train
path: "data/authors/topic_share/*.parquet"
- config_name: authors__author_topics
data_files:
- split: train
path: "data/authors/topics/*.parquet"
- config_name: authors__author_x_concepts
data_files:
- split: train
path: "data/authors/x_concepts/*.parquet"
- config_name: authors__source
data_files:
- split: train
path: "data/authors/**/*.jsonl.gz"
- config_name: awards__award_main
data_files:
- split: train
path: "data/awards/main/*.parquet"
- config_name: awards__award_funded_outputs
data_files:
- split: train
path: "data/awards/funded_outputs/*.parquet"
- config_name: awards__award_funders
data_files:
- split: train
path: "data/awards/funders/*.parquet"
- config_name: awards__award_investigators
data_files:
- split: train
path: "data/awards/investigators/*.parquet"
- config_name: awards__source
data_files:
- split: train
path: "data/awards/**/*.jsonl.gz"
- config_name: concepts__concept_main
data_files:
- split: train
path: "data/concepts/main/*.parquet"
- config_name: concepts__concept_counts_by_year
data_files:
- split: train
path: "data/concepts/counts_by_year/*.parquet"
- config_name: concepts__concept_external_ids
data_files:
- split: train
path: "data/concepts/external_ids/*.parquet"
- config_name: concepts__source
data_files:
- split: train
path: "data/concepts/**/*.jsonl.gz"
- config_name: continents__continent_countries
data_files:
- split: train
path: "data/continents/countries/*.parquet"
- config_name: continents__continent_main
data_files:
- split: train
path: "data/continents/main/*.parquet"
- config_name: continents__continent_display_name_alternatives
data_files:
- split: train
path: "data/continents/display_name_alternatives/*.parquet"
- config_name: continents__continent_external_ids
data_files:
- split: train
path: "data/continents/external_ids/*.parquet"
- config_name: continents__source
data_files:
- split: train
path: "data/continents/**/*.jsonl.gz"
- config_name: countries__countrie_main
data_files:
- split: train
path: "data/countries/main/*.parquet"
- config_name: countries__countrie_continents
data_files:
- split: train
path: "data/countries/continents/*.parquet"
- config_name: countries__countrie_display_name_alternatives
data_files:
- split: train
path: "data/countries/display_name_alternatives/*.parquet"
- config_name: countries__countrie_external_ids
data_files:
- split: train
path: "data/countries/external_ids/*.parquet"
- config_name: countries__source
data_files:
- split: train
path: "data/countries/**/*.jsonl.gz"
- config_name: domains__domain_main
data_files:
- split: train
path: "data/domains/main/*.parquet"
- config_name: domains__domain_display_name_alternatives
data_files:
- split: train
path: "data/domains/display_name_alternatives/*.parquet"
- config_name: domains__domain_fields
data_files:
- split: train
path: "data/domains/fields/*.parquet"
- config_name: domains__domain_external_ids
data_files:
- split: train
path: "data/domains/external_ids/*.parquet"
- config_name: domains__domain_siblings
data_files:
- split: train
path: "data/domains/siblings/*.parquet"
- config_name: domains__source
data_files:
- split: train
path: "data/domains/**/*.jsonl.gz"
- config_name: fields__field_main
data_files:
- split: train
path: "data/fields/main/*.parquet"
- config_name: fields__field_display_name_alternatives
data_files:
- split: train
path: "data/fields/display_name_alternatives/*.parquet"
- config_name: fields__field_domains
data_files:
- split: train
path: "data/fields/domains/*.parquet"
- config_name: fields__field_external_ids
data_files:
- split: train
path: "data/fields/external_ids/*.parquet"
- config_name: fields__field_siblings
data_files:
- split: train
path: "data/fields/siblings/*.parquet"
- config_name: fields__field_subfields
data_files:
- split: train
path: "data/fields/subfields/*.parquet"
- config_name: fields__source
data_files:
- split: train
path: "data/fields/**/*.jsonl.gz"
- config_name: funders__funder_alternate_titles
data_files:
- split: train
path: "data/funders/alternate_titles/*.parquet"
- config_name: funders__funder_main
data_files:
- split: train
path: "data/funders/main/*.parquet"
- config_name: funders__funder_counts_by_year
data_files:
- split: train
path: "data/funders/counts_by_year/*.parquet"
- config_name: funders__funder_external_ids
data_files:
- split: train
path: "data/funders/external_ids/*.parquet"
- config_name: funders__funder_roles
data_files:
- split: train
path: "data/funders/roles/*.parquet"
- config_name: funders__source
data_files:
- split: train
path: "data/funders/**/*.jsonl.gz"
- config_name: institution-types__institution-type_main
data_files:
- split: train
path: "data/institution-types/main/*.parquet"
- config_name: institution-types__source
data_files:
- split: train
path: "data/institution-types/**/*.jsonl.gz"
- config_name: institutions__institution_associated_institutions
data_files:
- split: train
path: "data/institutions/associated_institutions/*.parquet"
- config_name: institutions__institution_main
data_files:
- split: train
path: "data/institutions/main/*.parquet"
- config_name: institutions__institution_counts_by_year
data_files:
- split: train
path: "data/institutions/counts_by_year/*.parquet"
- config_name: institutions__institution_display_name_acronyms
data_files:
- split: train
path: "data/institutions/display_name_acronyms/*.parquet"
- config_name: institutions__institution_display_name_alternatives
data_files:
- split: train
path: "data/institutions/display_name_alternatives/*.parquet"
- config_name: institutions__institution_external_ids
data_files:
- split: train
path: "data/institutions/external_ids/*.parquet"
- config_name: institutions__institution_lineage
data_files:
- split: train
path: "data/institutions/lineage/*.parquet"
- config_name: institutions__institution_repositories
data_files:
- split: train
path: "data/institutions/repositories/*.parquet"
- config_name: institutions__institution_roles
data_files:
- split: train
path: "data/institutions/roles/*.parquet"
- config_name: institutions__institution_topic_share
data_files:
- split: train
path: "data/institutions/topic_share/*.parquet"
- config_name: institutions__institution_topics
data_files:
- split: train
path: "data/institutions/topics/*.parquet"
- config_name: institutions__source
data_files:
- split: train
path: "data/institutions/**/*.jsonl.gz"
- config_name: keywords__keyword_main
data_files:
- split: train
path: "data/keywords/main/*.parquet"
- config_name: keywords__source
data_files:
- split: train
path: "data/keywords/**/*.jsonl.gz"
- config_name: languages__language_main
data_files:
- split: train
path: "data/languages/main/*.parquet"
- config_name: languages__source
data_files:
- split: train
path: "data/languages/**/*.jsonl.gz"
- config_name: licenses__license_main
data_files:
- split: train
path: "data/licenses/main/*.parquet"
- config_name: licenses__source
data_files:
- split: train
path: "data/licenses/**/*.jsonl.gz"
- config_name: publishers__publisher_alternate_titles
data_files:
- split: train
path: "data/publishers/alternate_titles/*.parquet"
- config_name: publishers__publisher_main
data_files:
- split: train
path: "data/publishers/main/*.parquet"
- config_name: publishers__publisher_country_codes
data_files:
- split: train
path: "data/publishers/country_codes/*.parquet"
- config_name: publishers__publisher_counts_by_year
data_files:
- split: train
path: "data/publishers/counts_by_year/*.parquet"
- config_name: publishers__publisher_external_ids
data_files:
- split: train
path: "data/publishers/external_ids/*.parquet"
- config_name: publishers__publisher_lineage
data_files:
- split: train
path: "data/publishers/lineage/*.parquet"
- config_name: publishers__publisher_parent_publishers
data_files:
- split: train
path: "data/publishers/parent_publishers/*.parquet"
- config_name: publishers__publisher_roles
data_files:
- split: train
path: "data/publishers/roles/*.parquet"
- config_name: publishers__source
data_files:
- split: train
path: "data/publishers/**/*.jsonl.gz"
- config_name: sdgs__sdg_main
data_files:
- split: train
path: "data/sdgs/main/*.parquet"
- config_name: sdgs__sdg_external_ids
data_files:
- split: train
path: "data/sdgs/external_ids/*.parquet"
- config_name: sdgs__source
data_files:
- split: train
path: "data/sdgs/**/*.jsonl.gz"
- config_name: source-types__source-type_main
data_files:
- split: train
path: "data/source-types/main/*.parquet"
- config_name: source-types__source
data_files:
- split: train
path: "data/source-types/**/*.jsonl.gz"
- config_name: sources__source_alternate_titles
data_files:
- split: train
path: "data/sources/alternate_titles/*.parquet"
- config_name: sources__source_apc_prices
data_files:
- split: train
path: "data/sources/apc_prices/*.parquet"
- config_name: sources__source_main
data_files:
- split: train
path: "data/sources/main/*.parquet"
- config_name: sources__source_counts_by_year
data_files:
- split: train
path: "data/sources/counts_by_year/*.parquet"
- config_name: sources__source_host_organization_lineage
data_files:
- split: train
path: "data/sources/host_organization_lineage/*.parquet"
- config_name: sources__source_external_ids
data_files:
- split: train
path: "data/sources/external_ids/*.parquet"
- config_name: sources__source_issns
data_files:
- split: train
path: "data/sources/issns/*.parquet"
- config_name: sources__source_societies
data_files:
- split: train
path: "data/sources/societies/*.parquet"
- config_name: sources__source_topic_share
data_files:
- split: train
path: "data/sources/topic_share/*.parquet"
- config_name: sources__source_topics
data_files:
- split: train
path: "data/sources/topics/*.parquet"
- config_name: sources__source
data_files:
- split: train
path: "data/sources/**/*.jsonl.gz"
- config_name: subfields__subfield_main
data_files:
- split: train
path: "data/subfields/main/*.parquet"
- config_name: subfields__subfield_display_name_alternatives
data_files:
- split: train
path: "data/subfields/display_name_alternatives/*.parquet"
- config_name: subfields__subfield_domains
data_files:
- split: train
path: "data/subfields/domains/*.parquet"
- config_name: subfields__subfield_fields
data_files:
- split: train
path: "data/subfields/fields/*.parquet"
- config_name: subfields__subfield_external_ids
data_files:
- split: train
path: "data/subfields/external_ids/*.parquet"
- config_name: subfields__subfield_siblings
data_files:
- split: train
path: "data/subfields/siblings/*.parquet"
- config_name: subfields__subfield_topics
data_files:
- split: train
path: "data/subfields/topics/*.parquet"
- config_name: subfields__source
data_files:
- split: train
path: "data/subfields/**/*.jsonl.gz"
- config_name: topics__topic_main
data_files:
- split: train
path: "data/topics/main/*.parquet"
- config_name: topics__topic_domains
data_files:
- split: train
path: "data/topics/domains/*.parquet"
- config_name: topics__topic_fields
data_files:
- split: train
path: "data/topics/fields/*.parquet"
- config_name: topics__topic_external_ids
data_files:
- split: train
path: "data/topics/external_ids/*.parquet"
- config_name: topics__topic_keywords
data_files:
- split: train
path: "data/topics/keywords/*.parquet"
- config_name: topics__topic_siblings
data_files:
- split: train
path: "data/topics/siblings/*.parquet"
- config_name: topics__topic_subfields
data_files:
- split: train
path: "data/topics/subfields/*.parquet"
- config_name: topics__source
data_files:
- split: train
path: "data/topics/**/*.jsonl.gz"
- config_name: work-types__work-type_main
data_files:
- split: train
path: "data/work-types/main/*.parquet"
- config_name: work-types__source
data_files:
- split: train
path: "data/work-types/**/*.jsonl.gz"
- config_name: works__work_abstracts
data_files:
- split: train
path: "data/works/abstracts/*.parquet"
- config_name: works__work_main
data_files:
- split: train
path: "data/works/main/*.parquet"
- config_name: works__work_authorships
data_files:
- split: train
path: "data/works/authorships/*.parquet"
- config_name: works__work_awards
data_files:
- split: train
path: "data/works/awards/*.parquet"
- config_name: works__work_concepts
data_files:
- split: train
path: "data/works/concepts/*.parquet"
- config_name: works__work_corresponding_author_ids
data_files:
- split: train
path: "data/works/corresponding_author_ids/*.parquet"
- config_name: works__work_corresponding_institution_ids
data_files:
- split: train
path: "data/works/corresponding_institution_ids/*.parquet"
- config_name: works__work_counts_by_year
data_files:
- split: train
path: "data/works/counts_by_year/*.parquet"
- config_name: works__work_funders
data_files:
- split: train
path: "data/works/funders/*.parquet"
- config_name: works__work_external_ids
data_files:
- split: train
path: "data/works/external_ids/*.parquet"
- config_name: works__work_indexed_in
data_files:
- split: train
path: "data/works/indexed_in/*.parquet"
- config_name: works__work_keywords
data_files:
- split: train
path: "data/works/keywords/*.parquet"
- config_name: works__work_locations
data_files:
- split: train
path: "data/works/locations/*.parquet"
- config_name: works__work_mesh
data_files:
- split: train
path: "data/works/mesh/*.parquet"
- config_name: works__work_referenced_works
data_files:
- split: train
path: "data/works/referenced_works/*.parquet"
- config_name: works__work_related_works
data_files:
- split: train
path: "data/works/related_works/*.parquet"
- config_name: works__work_sustainable_development_goals
data_files:
- split: train
path: "data/works/sustainable_development_goals/*.parquet"
- config_name: works__work_topics
data_files:
- split: train
path: "data/works/topics/*.parquet"
- config_name: works__source
data_files:
- split: train
path: "data/works/**/*.jsonl.gz"
pretty_name: OpenAlex Snapshot
license: cc0-1.0
papers:
- https://arxiv.org/abs/2205.01833
annotations_creators:
- found
- machine-generated
language_creators:
- found
source_datasets:
- original
tags:
- academic
- scholarly-metadata
- citation-data
- bibliometrics
- open-science
- tabular
language:
- en
- multilingual
size_categories:
- n>1T
task_categories:
- tabular-classification
- feature-extraction
doi: 10.57967/hf/7682
---
# OpenAlex Snapshot
Mirror of the OpenAlex scholarly metadata snapshot — a free, open catalogue of 250M+ scholarly works, 100M+ authors, and related entities.
Hosted on HuggingFace via Xet for content-addressable deduplication.
**Source**: [s3://openalex](https://registry.opendata.aws/openalex/) (public, anonymous S3 bucket)
## Dataset subsets
Each entity type is a separate subset (config). For each entity, there is:
- One `__source` subset containing the raw `.jsonl.gz` source files
- One subset per extracted relationship table (e.g. `works__main`, `works__abstracts`, `authors__affiliations`)
| Entity | Description |
|--------|-------------|
| works | Scholarly works (papers, datasets, etc.) |
| authors | Authors of scholarly works |
| institutions | Universities, research orgs |
| publishers | Academic publishers |
| sources | Journals, repositories, conferences |
| awards | Grant/funding awards |
| concepts | Legacy concept taxonomy (Wikidata) |
| topics | Topic taxonomy |
| domains | Top-level topic domains |
| fields | Topic fields |
| subfields | Topic subfields |
| funders | Funding organisations |
| keywords | Machine-learning keywords |
| continents | Continents |
| countries | Countries |
| languages | Languages |
| licenses | Licences |
| sdgs | Sustainable Development Goals |
| institution-types | Institution types |
| source-types | Source types |
| work-types | Work types |
## Data format
Each shard is a gzip-compressed JSON Lines file at:
```
data/{entity}/updated_date=YYYY-MM-DD/part_XXXX.jsonl.gz
```
The `.jsonl.gz` extension allows the HuggingFace dataset viewer to detect the inner format automatically. On S3, files are named `part_XXXX.gz`; the download pipeline renames them on save.
Each line is a JSON object representing one entity record. Fields vary by entity type. See the [OpenAlex data model](https://docs.openalex.org/about-the-data) for field definitions.
### Extracted Parquet tables
The sync pipeline extracts relationship tables from each entity into Parquet files. Each entity has a `main` table (scalar attributes, one row per entity) plus separate tables for each list/dict-valued field:
```
data/{entity}/
updated_date=YYYY-MM-DD/part_XXXX.jsonl.gz # source data
main/
{entity}__updated_date=...__part_XXXX.parquet # scalar attributes
{relationship_type}/
{entity}__updated_date=...__part_XXXX.parquet # one edge table per list/dict field
```
The dataset viewer provides one subset per entity+relationship combination (e.g. `works__main`, `works__abstracts`, `authors__affiliations`) and one `__source` subset per entity for the raw JSONL.
### Example: Work record fields
`id`, `doi`, `title`, `display_name`, `publication_year`, `type`, `language`, `authorships`, `concepts`, `topics`, `keywords`, `cited_by_count`, `referenced_works`, `related_works`, `locations`, `open_access`, `funders`, `awards`, `mesh`, `sustainable_development_goals`, `counts_by_year`, `updated_date`, and more.
## Sync and extraction pipeline
The [sync/](https://github.com/Mearman/OpenAlex/tree/main/sync) directory contains a Python pipeline for downloading from S3 and extracting relationship tables to Parquet:
```bash
# Full sync (all entities)
python3 -m sync
# Limit to one entity
python3 -m sync --entity works
# Split extraction across machines
python3 -m sync --slice-index 0 --slice-total 2 # machine 1
python3 -m sync --slice-index 1 --slice-total 2 # machine 2
```
## License
OpenAlex data is released under [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/). See the [OpenAlex terms](https://openalex.org/about) for details.
## Links
- [OpenAlex documentation](https://docs.openalex.org)
- [OpenAlex API](https://api.openalex.org)
- [AWS Open Data Registry](https://registry.opendata.aws/openalex/)
- [Extraction pipeline source](https://github.com/Mearman/OpenAlex)