Skip to content

Commit

Permalink
Fix some typos and format changes
Browse files Browse the repository at this point in the history
- Fix spelling 'mistake'

- Fix another typo

- Fix shields.io badge using new format

- Fix hopefully final typo
  • Loading branch information
ml-evs committed Dec 21, 2022
1 parent 7248726 commit 2ba4fed
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MODNet: Material Optimal Descriptor Network

[![arXiv](https://img.shields.io/badge/arXiv-2004.14766-brightgreen)](https://arxiv.org/abs/2004.14766) [![Build Status](https://img.shields.io/github/workflow/status/ppdebreuck/modnet/Run%20tests?logo=github)](https://github.com/ppdebreuck/modnet/actions?query=branch%3Amaster+) [![Read the Docs](https://img.shields.io/readthedocs/modnet)](https://modnet.readthedocs.io/en/latest/)
[![arXiv](https://img.shields.io/badge/arXiv-2004.14766-brightgreen)](https://arxiv.org/abs/2004.14766) [![Build Status](https://img.shields.io/github/actions/workflow/status/ppdebreuck/modnet/ci.yml?logo=github&branch=main)](https://github.com/ppdebreuck/modnet/actions?query=branch%3Amaster+) [![Read the Docs](https://img.shields.io/readthedocs/modnet)](https://modnet.readthedocs.io/en/latest/)

<a name="introduction"></a>
## Introduction
Expand Down
8 changes: 5 additions & 3 deletions modnet/featurizers/presets/debreuck_2020.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,14 @@ def __init__(self, fast_oxid: bool = False):
"""
import matminer

if matminer.__version__ != self.package_version_requirements["matminer"]:
if matminer.__version__ != self.package_version_requirements[
"matminer"
].replace("==", ""):
warnings.warn(
f"The {self.__class__.__name__} preset was written for and tested only with matminer{self.package_version_requirements['matminer']}.\n"
"Newer versions of matminer will not work, and older versions may not be compatible with newer MODNet versions due to other conflicts.\n"
"To use this featurizer robustly, please install `modnet==0.1.13` with its pinned dependencies.\n\n"
"This preset will now be initialised without importing matminer featurisers to enable use with existing previously featurized data, "
"This preset will now be initialised without importing matminer featurizers to enable use with existing previously featurized data, "
"but attempts to perform further featurization will result in an error."
)

Expand Down Expand Up @@ -246,7 +248,7 @@ def featurize_site(self, df):

class CompositionOnlyFeaturizer(DeBreuck2020Featurizer):
"""This subclass simply disables structure and site-level features
frm the main `DeBreuck2020Featurizer` class.
from the main `DeBreuck2020Featurizer` class.
**Materials property prediction for limited datasets enabled
by feature selection and joint learning with MODNet**
Expand Down
2 changes: 1 addition & 1 deletion modnet/featurizers/presets/matminer_2023.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def featurize_site(self, df):

class CompositionOnlyMatminer2023Featurizer(Matminer2023Featurizer):
"""This subclass simply disables structure and site-level features
frm the main `Matminer2023Featurizer` class.
from the main `Matminer2023Featurizer` class.
This should yield identical results to the original 2020 version.
Expand Down

0 comments on commit 2ba4fed

Please sign in to comment.