Skip to content

Commit 0176517

Browse files
author
sfluegel
committed
update readme - document PR ChEB-AI#39
1 parent 7dc4e63 commit 0176517

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@
33
ChEBai is a deep learning library designed for the integration of deep learning methods with chemical ontologies, particularly ChEBI.
44
The library emphasizes the incorporation of the semantic qualities of the ontology into the learning process.
55

6+
## Note for developers
7+
8+
If you have used ChEBai before PR #39, the file structure in which your ChEBI-data is saved has changed. This means that
9+
datasets will be freshly generated. The data however is the same. If you want to keep the old data (including the old
10+
splits), you can use a migration script. It copies the old data to the new location for a specific ChEBI class
11+
(including chebi version and other parameters). The script can be called by specifying the data module from a config
12+
```
13+
python chebai/preprocessing/migration/chebi_data_migration.py migrate --datamodule=[path-to-data-config]
14+
```
15+
or by specifying the class name (e.g. `ChEBIOver50`) and arguments separately
16+
```
17+
python chebai/preprocessing/migration/chebi_data_migration.py migrate --class_name=[data-class] [--chebi_version=[version]]
18+
```
19+
The new dataset will by default generate random data splits (with a given seed).
20+
To reuse a fixed data split, you have to provide the path of the csv file generated during the migration:
21+
`--data.init_args.splits_file_path=[path-to-processed_data]/splits.csv`
22+
623
## Installation
724

825
To install ChEBai, follow these steps:

0 commit comments

Comments
 (0)