rename pages /about-test-test-set to /about-the-data and /how-to-contribute to /contribute

clean up gitignore

Author: janosh

.gitignore

@@ -1,14 +1,11 @@
 # package install
 *.egg-info
 dist
-build
 
 # cache
 __pycache__
-.coverage*
 
 # datasets
-*.p
 *.json.gz
 *.json.bz2
 *.csv.bz2
@@ -17,17 +14,13 @@ data/**/raw
 data/2022-*
 data/m3gnet-*
 
-# Weights and Biases logs
+# slurm + Weights and Biases logs
 wandb/
-job-logs/
-
-# slurm logs
 *slurm-*.log
 
 # generated docs
 site/src/routes/api/*.md
 
 # temporary ignore rules
 notes
-models/voronoi/*.zip
 2023-02-05-ens=10-perturb=5

data/wbm/analysis.py

@@ -18,7 +18,7 @@
 
 module_dir = os.path.dirname(__file__)
 print(f"{pio.templates.default=}")
-about_data_page = f"{ROOT}/site/src/routes/about-the-test-set"
+about_data_page = f"{ROOT}/site/src/routes/about-the-data"
 
 
 # %%

matbench_discovery/data.py

@@ -60,7 +60,7 @@ def load_train_test(
     Recognized data keys are mp-computed-structure-entries, mp-elemental-ref-energies,
     mp-energies, mp-patched-phase-diagram, wbm-computed-structure-entries,
     wbm-initial-structures, wbm-summary. See
-    https://janosh.github.io/matbench-discovery/how-to-contribute for data descriptions.
+    https://janosh.github.io/matbench-discovery/contribute for data descriptions.
 
     Args:
         data_names (str | list[str], optional): Which parts of the MP/WBM data to load.

readme.md

@@ -21,6 +21,6 @@ In version 1 of this benchmark, we explore 8 models covering multiple methodolog
 
 <slot name="metrics-table" />
 
-We welcome contributions that add new models to the leaderboard through [GitHub PRs](https://github.com/janosh/matbench-discovery/pulls). See the [usage and contributing guide](https://janosh.github.io/matbench-discovery/how-to-contribute) for details.
+We welcome contributions that add new models to the leaderboard through [GitHub PRs](https://github.com/janosh/matbench-discovery/pulls). See the [usage and contributing guide](https://janosh.github.io/matbench-discovery/contribute) for details.
 
 For a version 2 release of this benchmark, we plan to merge the current training and test sets into the new training set and acquire a much larger test set compared to the v1 test set of 257k structures.

site/src/routes/about-the-test-set/+page.svelte site/src/routes/about-the-data/+page.svelte

@@ -184,4 +184,4 @@ This information can be very useful for someone looking to reproduce your result
 
 ## 😵‍💫   Troubleshooting
 
-Having problems using or contributing to the project? Please [open an issue on GitHub]({repo}/issues). Happy to help! 😊
+Having problems using or contributing to the project? Please [open an issue on GitHub]({repo}/issues) or [start a discussion]({repo}/discussions) for open-ended conversations. Happy to help! 😊

site/src/routes/about-the-test-set/tmi/+page.svelte site/src/routes/about-the-data/tmi/+page.svelte

@@ -92,7 +92,7 @@ The choice of data for the train and test sets of this benchmark fell on the lat
 
 ## Results
 
-Our benchmark is designed to make [adding future models easy](/how-to-contribute). The initial release compares the following [models](/models):
+Our benchmark is designed to make [adding future models easy](/contribute). The initial release compares the following [models](/models):
 
 1. [CGCNN](https://arxiv.org/abs/1710.10324) @xie_crystal_2018
 1. [BOWSR](https://sciencedirect.com/science/article/pii/S1369702121002984) @zuo_accelerating_2021

site/src/routes/about-the-test-set/wbm-element-counts-arity=2.json site/src/routes/about-the-data/wbm-element-counts-arity=2.json

@@ -111,7 +111,7 @@ def test_load_train_test_doc_str() -> None:
     for name in DATA_FILENAMES:
         assert name in doc_str, f"Missing data {name=} in load_train_test() docstring"
 
-    route = "/how-to-contribute"
+    route = "/contribute"
     assert os.path.isdir(f"{ROOT}/site/src/routes/{route}")