Skip to content

Commit

Permalink
add paper/repo/PR links column to metrics table
Browse files Browse the repository at this point in the history
  • Loading branch information
janosh committed Dec 22, 2024
1 parent faef34e commit c253c5d
Show file tree
Hide file tree
Showing 27 changed files with 50 additions and 11 deletions.
1 change: 1 addition & 0 deletions models/alignn/alignn.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ targets: E
model_params: 4_026_753 # pre-trained 'mp_e_form_alignn' and our custom MBD checkpoint have the same size
# for other hyperparams, see alignn-config.json
n_estimators: 1
pr_url: https://github.com/janosh/matbench-discovery/pull/85

# model trained from specifically for MBD
training_set: [MP 2022]
Expand Down
1 change: 1 addition & 0 deletions models/alignn_ff/alignn-ff.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ url: https://jarvis.nist.gov/jalignn
doi: https://doi.org/10.1039/D2DD00096B
paper: https://arxiv.org/abs/2209.05554
pypi: https://pypi.org/project/alignn
pr_url: https://github.com/janosh/matbench-discovery/pull/37

requirements:
ase: 3.22.0
Expand Down
1 change: 1 addition & 0 deletions models/bowsr/bowsr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ url: https://materialsvirtuallab.github.io/maml
doi: https://doi.org/10.1016/j.mattod.2021.08.012
paper: https://arxiv.org/abs/2104.10242
pypi: https://pypi.org/project/maml
pr_url: https://github.com/janosh/matbench-discovery/pull/85

requirements:
maml: 2022.9.20
Expand Down
1 change: 1 addition & 0 deletions models/cgcnn/cgcnn+p.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ authors:
repo: https://github.com/JasonGibsonUfl/Augmented_CGCNN
doi: https://doi.org/10.1038/s41524-022-00891-8
paper: https://arxiv.org/abs/2202.13947
pr_url: https://github.com/janosh/matbench-discovery/pull/85

requirements:
aviary: https://github.com/CompRhys/aviary/releases/tag/v0.1.0
Expand Down
1 change: 1 addition & 0 deletions models/cgcnn/cgcnn.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ authors:
repo: https://github.com/CompRhys/aviary
doi: https://doi.org/10.1103/PhysRevLett.120.145301
paper: https://arxiv.org/abs/1710.10324
pr_url: https://github.com/janosh/matbench-discovery/pull/85

requirements:
aviary: https://github.com/CompRhys/aviary/releases/tag/v0.1.0
Expand Down
1 change: 1 addition & 0 deletions models/chgnet/chgnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ repo: https://github.com/CederGroupHub/chgnet
doi: https://doi.org/10.48550/arXiv.2302.14231
paper: https://arxiv.org/abs/2302.14231
pypi: https://pypi.org/project/chgnet
pr_url: https://github.com/janosh/matbench-discovery/pull/85

requirements:
torch: 1.11.0
Expand Down
1 change: 1 addition & 0 deletions models/eqV2/eqV2-m-omat-mp-salex.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ doi: https://doi.org/10.48550/arXiv.2410.12771
paper: https://arxiv.org/abs/2410.12771
url: https://huggingface.co/fairchem/OMAT24
pypi: https://pypi.org/project/fairchem-core
pr_url: https://github.com/janosh/matbench-discovery/pull/146

requirements:
fairchem-core: 1.2.1
Expand Down
1 change: 1 addition & 0 deletions models/eqV2/eqV2-s-dens-mp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ doi: https://doi.org/10.48550/arXiv.2410.12771
paper: https://arxiv.org/abs/2410.12771
url: https://huggingface.co/fairchem/OMAT24
pypi: https://pypi.org/project/fairchem-core
pr_url: https://github.com/janosh/matbench-discovery/pull/146

requirements:
fairchem-core: 1.2.1
Expand Down
1 change: 1 addition & 0 deletions models/gnome/gnome.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ authors:
repo: https://github.com/google-deepmind/materials_discovery
doi: https://doi.org/10.1038/s41586-023-06735-9
paper: https://nature.com/articles/s41586-023-06735-9
pr_url: https://github.com/janosh/matbench-discovery/pull/84

requirements:
e3nn-jax: 0.20.3
Expand Down
3 changes: 2 additions & 1 deletion models/grace2l_r6/grace2l-r6.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ trained_by:
repo: https://github.com/ICAMS/grace-tensorpotential
doi: https://doi.org/10.1103/PhysRevX.14.021036
paper: https://journals.aps.org/prx/abstract/10.1103/PhysRevX.14.021036
url: https://gracemaker.readthedocs.io/en/latest/gracemaker/foundation/
url: https://gracemaker.readthedocs.io/en/latest/gracemaker/foundation
pr_url: https://github.com/janosh/matbench-discovery/pull/160

requirements:
tensorpotential: 0.4.4
Expand Down
1 change: 1 addition & 0 deletions models/m3gnet/m3gnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ url: https://materialsvirtuallab.github.io/m3gnet
doi: https://doi.org/10.1038/s43588-022-00349-3
paper: https://arxiv.org/abs/2202.02450
pypi: https://pypi.org/project/matgl
pr_url: https://github.com/janosh/matbench-discovery/pull/85

requirements:
m3gnet: 0.1.0
Expand Down
2 changes: 2 additions & 0 deletions models/mace/mace-mp-0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,12 @@ trained_by:
affiliation: Lawrence Berkeley National Laboratory
orcid: https://orcid.org/0000-0002-4017-7084
github: https://github.com/chiang-yuan

repo: https://github.com/ACEsuit/mace
doi: https://doi.org/10.48550/arXiv.2401.00096
paper: https://arxiv.org/abs/2401.00096
pypi: https://pypi.org/project/mace-torch
pr_url: https://github.com/janosh/matbench-discovery/pull/48

requirements:
mace-torch: 0.3.3
Expand Down
2 changes: 2 additions & 0 deletions models/mace/mace-mpa-0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ trained_by:
affiliation: University of Cambridge
email: ilyes.batatia@ens-paris-saclay.fr
orcid: https://orcid.org/0000-0001-6915-9851

repo: https://github.com/ACEsuit/mace
doi: https://doi.org/10.48550/arXiv.2401.00096
paper: https://arxiv.org/abs/2401.00096
pypi: https://pypi.org/project/mace-torch
pr_url: https://github.com/janosh/matbench-discovery/pull/175

requirements:
mace-torch: 0.3.9
Expand Down
1 change: 1 addition & 0 deletions models/mattersim/mattersim-v1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ authors:
repo: https://github.com/microsoft/mattersim
doi: https://doi.org/10.48550/arXiv.2405.04967
paper: https://arxiv.org/abs/2405.04967
pr_url: https://github.com/janosh/matbench-discovery/pull/178

requirements:
Graphormer: v1
Expand Down
1 change: 1 addition & 0 deletions models/megnet/megnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ url: https://materialsvirtuallab.github.io/megnet
doi: https://doi.org/10.1021/acs.chemmater.9b01294
paper: https://arxiv.org/abs/1812.05055
pypi: https://pypi.org/project/megnet
pr_url: https://github.com/janosh/matbench-discovery/pull/85

requirements:
megnet: 1.3.2
Expand Down
1 change: 1 addition & 0 deletions models/orb/orb-mptrj.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ repo: https://github.com/orbital-materials/orb-models
url: https://orbitalmaterials.com/post/technical-blog-introducing-the-orb-ai-based-interatomic-potential
doi: https://doi.org/10.48550/arXiv.2410.22570
paper: https://arxiv.org/abs/2410.22570
pr_url: https://github.com/janosh/matbench-discovery/pull/133

openness: OSOD
trained_for_benchmark: true
Expand Down
1 change: 1 addition & 0 deletions models/orb/orb.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ repo: https://github.com/orbital-materials/orb-models
url: https://orbitalmaterials.com/post/technical-blog-introducing-the-orb-ai-based-interatomic-potential
doi: https://doi.org/10.48550/arXiv.2410.22570
paper: https://arxiv.org/abs/2410.22570
pr_url: https://github.com/janosh/matbench-discovery/pull/133

openness: OSCD
trained_for_benchmark: false
Expand Down
1 change: 1 addition & 0 deletions models/sevennet/sevennet-0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ url: https://github.com/MDIL-SNU/SevenNet/tree/afb56e10b6/sevenn/pretrained_pote
doi: https://doi.org/10.1021/acs.jctc.4c00190
paper: https://arxiv.org/abs/2402.03789
pypi: https://pypi.org/project/sevenn
pr_url: https://github.com/janosh/matbench-discovery/pull/112

openness: OSOD
trained_for_benchmark: false
Expand Down
1 change: 1 addition & 0 deletions models/sevennet/sevennet-l3i5.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ url: https://github.com/MDIL-SNU/SevenNet/blob/main/sevenn/pretrained_potentials
doi: https://doi.org/10.1021/acs.jctc.4c00190
paper: https://arxiv.org/abs/2402.03789
pypi: https://pypi.org/project/sevenn
pr_url: https://github.com/janosh/matbench-discovery/pull/172

openness: OSOD
trained_for_benchmark: false
Expand Down
1 change: 1 addition & 0 deletions models/voronoi_rf/voronoi-rf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ repo: https://github.com/janosh/matbench-discovery
doi: https://doi.org/10.1103/PhysRevB.96.024104
paper: https://doi.org/10.1103/PhysRevB.96.024104
pypi: https://pypi.org/project/scikit-learn
pr_url: https://github.com/janosh/matbench-discovery/commit/f28cc6d

requirements:
matminer: 0.8.0
Expand Down
9 changes: 6 additions & 3 deletions models/wrenformer/wrenformer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ authors:
affiliation: University of Cambridge
email: re344@cam.ac.uk
orcid: https://orcid.org/0000-0001-6397-0002
repo: https://github.com/CompRhys/aviary
doi: https://doi.org/10.1126/sciadv.abn4117
paper: https://arxiv.org/abs/2106.11132

requirements:
aviary: https://github.com/CompRhys/aviary/releases/tag/v0.1.0
torch: 1.11.0
Expand All @@ -27,6 +25,11 @@ requirements:
numpy: 1.24.0
pandas: 1.5.1

repo: https://github.com/CompRhys/aviary
doi: https://doi.org/10.1126/sciadv.abn4117
paper: https://arxiv.org/abs/2106.11132
pr_url: https://github.com/janosh/matbench-discovery/pull/85

openness: OSOD
trained_for_benchmark: true
train_task: RP2RE
Expand Down
3 changes: 0 additions & 3 deletions site/src/app.css
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,6 @@ table :is(td, th) {
border: 1px solid gray;
padding: 2pt 4pt;
}
table.metrics :is(td, th) {
padding: 2pt 4pt !important;
}
tbody tr:nth-child(odd) {
background: rgba(0, 0, 0, 0.5);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
model_is_compliant,
} from '$lib'
import { pretty_num } from 'elementari'
import type { HeatmapColumn, ModelData } from './types.ts'
import type { HeatmapColumn, ModelData } from './types.js'
export let discovery_set: `full_test_set` | `most_stable_10k` | `unique_prototypes` =
`unique_prototypes`
Expand All @@ -20,6 +20,10 @@
{ label: `Params`, tooltip: `Number of trainable model parameters` },
{ label: `Targets`, tooltip: `Target property used to train the model` },
{ label: `Date Added`, tooltip: `Submission date to the leaderboard` },
{
label: `Links`,
tooltip: `Model resources: paper, code repository and submission pull request`,
},
]
let columns: HeatmapColumn[]
Expand Down Expand Up @@ -165,6 +169,16 @@
Params: `<span title="${pretty_num(model.model_params, `,`)} trainable model parameters">${pretty_num(model.model_params)}</span>`,
Targets: targets_str,
'Date Added': `<span title="${long_date(model.date_added)}">${model.date_added}</span>`,
Links: [
model.paper &&
`<a href="${model.paper}" target="_blank" rel="noopener noreferrer" title="Paper">📄</a>`,
model.repo &&
`<a href="${model.repo}" target="_blank" rel="noopener noreferrer" title="Code repository">📦</a>`,
model.pr_url &&
`<a href="${model.pr_url}" target="_blank" rel="noopener noreferrer" title="Pull Request">🔗</a>`,
]
.filter(Boolean)
.join(` `),
}
})
.sort((row1, row2) => (row2.F1 ?? 0) - (row1.F1 ?? 0)) // Sort by F1 score descending
Expand Down
2 changes: 1 addition & 1 deletion site/src/lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ import type { ModelMetadata } from './model-schema'
import type { ModelData } from './types'

export { default as TRAINING_SETS } from '$data/training-sets.yml'
export { default as DiscoveryMetricsTable } from './DiscoveryMetricsTable.svelte'
export { default as Footer } from './Footer.svelte'
export { default as GeoOptMetricsTable } from './GeoOptMetricsTable.svelte'
export { default as HeatmapTable } from './HeatmapTable.svelte'
export { default as MetricsTable } from './MetricsTable.svelte'
export { default as AuthorBrief } from './ModelAuthor.svelte'
export { default as ModelCard } from './ModelCard.svelte'
export { default as Nav } from './Nav.svelte'
Expand Down
1 change: 1 addition & 0 deletions site/src/lib/model-schema.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export interface ModelMetadata {
paper: string
url?: string
pypi?: string
pr_url: string
requirements: {
/**
* This interface was referenced by `undefined`'s JSON-Schema definition
Expand Down
4 changes: 2 additions & 2 deletions site/src/routes/+page.svelte
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<script lang="ts">
import type { ModelData } from '$lib'
import { DiscoveryMetricsTable, model_is_compliant, MODEL_METADATA } from '$lib'
import { MetricsTable, model_is_compliant, MODEL_METADATA } from '$lib'
import Readme from '$root/readme.md'
import KappaNote from '$site/src/routes/kappa-note.md'
import LandingPageFigs from '$site/src/routes/landing-page-figs.md'
Expand Down Expand Up @@ -88,7 +88,7 @@
</Tooltip>
{/each}
</div>
<DiscoveryMetricsTable
<MetricsTable
{show_non_compliant}
{hide_cols}
{show_energy_only}
Expand Down
2 changes: 2 additions & 0 deletions tests/model-schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ properties:
paper: *url
url: *url
pypi: *url
pr_url: *url
requirements:
type: object
patternProperties:
Expand Down Expand Up @@ -243,6 +244,7 @@ required:
- model_version
- n_estimators
- paper
- pr_url
- repo
- requirements
- targets
Expand Down

0 comments on commit c253c5d

Please sign in to comment.