cyrusyc commited on
Commit
07722d8
·
1 Parent(s): f0fdb88

update README

Browse files
Files changed (2) hide show
  1. .github/README.md +6 -0
  2. README.md +6 -0
.github/README.md CHANGED
@@ -1,5 +1,11 @@
1
  # mlip-arena
2
 
 
 
 
 
 
 
3
  MLIP Arena is an open-source platform for benchmarking machine learning interatomic potentials (MLIPs). The platform provides a unified interface for users to evaluate the performance of their models on a variety of tasks, including single-point density functional theory calculations and molecular dynamics simulations. The platform is designed to be extensible, allowing users to contribute new models, benchmarks, and training data to the platform.
4
 
5
  ## Contribute
 
1
  # mlip-arena
2
 
3
+ > [!CAUTION]
4
+ > MLIP Arena is currently in pre-alpha. The results are not stable. Please intepret them with care.
5
+
6
+ > [!NOTE]
7
+ > If you're interested in joining the effort, please reach out to Yuan at [[email protected]](mailto:[email protected]).
8
+
9
  MLIP Arena is an open-source platform for benchmarking machine learning interatomic potentials (MLIPs). The platform provides a unified interface for users to evaluate the performance of their models on a variety of tasks, including single-point density functional theory calculations and molecular dynamics simulations. The platform is designed to be extensible, allowing users to contribute new models, benchmarks, and training data to the platform.
10
 
11
  ## Contribute
README.md CHANGED
@@ -8,6 +8,12 @@ app_file: serve/app.py
8
 
9
  # mlip-arena
10
 
 
 
 
 
 
 
11
  MLIP Arena is an open-source platform for benchmarking machine learning interatomic potentials (MLIPs). The platform provides a unified interface for users to evaluate the performance of their models on a variety of tasks, including single-point density functional theory calculations and molecular dynamics simulations. The platform is designed to be extensible, allowing users to contribute new models, benchmarks, and training data to the platform.
12
 
13
  ## Contribute
 
8
 
9
  # mlip-arena
10
 
11
+ > [!CAUTION]
12
+ > MLIP Arena is currently in pre-alpha. The results are not stable. Please intepret them with care.
13
+
14
+ > [!NOTE]
15
+ > If you're interested in joining the effort, please reach out to Yuan at [[email protected]](mailto:[email protected]).
16
+
17
  MLIP Arena is an open-source platform for benchmarking machine learning interatomic potentials (MLIPs). The platform provides a unified interface for users to evaluate the performance of their models on a variety of tasks, including single-point density functional theory calculations and molecular dynamics simulations. The platform is designed to be extensible, allowing users to contribute new models, benchmarks, and training data to the platform.
18
 
19
  ## Contribute