Update README.md (#3)
Browse files- Update README.md (7f86c45e54226dfd1a233d64b42e044401bff87f)
Co-authored-by: Heloise Chomet <[email protected]>
    	
        README.md
    CHANGED
    
    | @@ -3,17 +3,25 @@ | |
| 3 | 
             
            # Doc / guide: https://huggingface.co/docs/hub/datasets-cards
         | 
| 4 | 
             
            {}
         | 
| 5 | 
             
            ---
         | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
| 6 | 
             
            # SPICE2_curated
         | 
| 7 | 
             
            The provided dataset is based on the version 2 SPICE dataset. The SPICE dataset was chosen for its diversity, both in chemical and conformational space,
         | 
| 8 | 
             
            compromising of approximately 2 million structures computed at the ωB97M-D3(BJ)/def2-TZVPPD level of theory.
         | 
| 9 | 
             
            ## Dataset Structure
         | 
| 10 | 
             
            The provided dataset is split into a training set and a validation set with a 95/5 split. The split was done per molecular
         | 
| 11 | 
             
            SMILES, insuring that different conformations of the same molecule do not appear in both the training and
         | 
| 12 | 
            -
            validation set. The training set contains 1  | 
| 13 | 
             
            ## Filtering Process
         | 
| 14 | 
             
            The version 2 SPICE dataset was filtered by removing the following structures:
         | 
| 15 | 
             
            - **Unphysical structures:** Only keeping structures where all hydrogen atoms have exactly one bond (removing 42 689 structures). 
         | 
| 16 | 
             
            - **Charged systems:** Removing all charged systems (removing 142 647 structures).
         | 
| 17 | 
             
            - **High forces:** Applying a total force filter of 0.1 eV/A and a maximum force filter of 15 eV/A (removing 1 024 structures).
         | 
|  | |
|  | |
| 18 | 
             
            ## Version 2 SPICE dataset source
         | 
| 19 | 
             
            https://pubs.acs.org/doi/10.1021/acs.jctc.4c00794
         | 
|  | |
| 3 | 
             
            # Doc / guide: https://huggingface.co/docs/hub/datasets-cards
         | 
| 4 | 
             
            {}
         | 
| 5 | 
             
            ---
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            # Update
         | 
| 8 | 
            +
            As of the mlip v0.1.2 release, the SPICE2 curated dataset was also updated.
         | 
| 9 | 
            +
            The main reason the removal of a small number of structures that led to unusually high energy errors with our models.
         | 
| 10 | 
            +
            We also wanted to remove structures with Li, K and Na atomis, as these elements were absent from the validation set.
         | 
| 11 | 
            +
            0.2 % of the training set and validation set was removed. Details added to the filtering process below.
         | 
| 12 | 
             
            # SPICE2_curated
         | 
| 13 | 
             
            The provided dataset is based on the version 2 SPICE dataset. The SPICE dataset was chosen for its diversity, both in chemical and conformational space,
         | 
| 14 | 
             
            compromising of approximately 2 million structures computed at the ωB97M-D3(BJ)/def2-TZVPPD level of theory.
         | 
| 15 | 
             
            ## Dataset Structure
         | 
| 16 | 
             
            The provided dataset is split into a training set and a validation set with a 95/5 split. The split was done per molecular
         | 
| 17 | 
             
            SMILES, insuring that different conformations of the same molecule do not appear in both the training and
         | 
| 18 | 
            +
            validation set. The training set contains 1 734 158 structures and the validation set  87 764 structures.
         | 
| 19 | 
             
            ## Filtering Process
         | 
| 20 | 
             
            The version 2 SPICE dataset was filtered by removing the following structures:
         | 
| 21 | 
             
            - **Unphysical structures:** Only keeping structures where all hydrogen atoms have exactly one bond (removing 42 689 structures). 
         | 
| 22 | 
             
            - **Charged systems:** Removing all charged systems (removing 142 647 structures).
         | 
| 23 | 
             
            - **High forces:** Applying a total force filter of 0.1 eV/A and a maximum force filter of 15 eV/A (removing 1 024 structures).
         | 
| 24 | 
            +
            - **High energy errors:** Removing structures with high z-score when computing energy errors with our three trained models (removing 3656 structures from training and 158 from validation).
         | 
| 25 | 
            +
            - **Atomic species** Removing any structures containing Li, K or Na (removing 82 structures)
         | 
| 26 | 
             
            ## Version 2 SPICE dataset source
         | 
| 27 | 
             
            https://pubs.acs.org/doi/10.1021/acs.jctc.4c00794
         | 
