Skip to content

Commit

Permalink
### Added
Browse files Browse the repository at this point in the history
* The 'train()' method was added to the 'core.model.DGDModel' class to train the DGD model.

* The 'dgd_train' executable was added to train the DGD model using the command line.

* A new type of configuration file containing the options to train the DGD model is available. An example of such a configuration file can be found in the newly created 'bulkDGD/ioutil/configs/training' directory inside the package. This file, together with the other configuration files, is installed together with the package.

* A new example of configuration file ('model_untrained.yaml') containing the options to set up the DGD model is available in the 'bulkDGD/ioutil/configs/model' directory for when the model needs to be set up before training.

* A new tutorial on how to train the DGD model was added to the documentation (Tutorial 3).

* The 'load_loss()' and 'save_loss()' functions were introduced in the new 'bulkDGD.ioutil.lossio' module to load and save CSV files containing the losses reported during the training procedure.

### API-breaking changes

* The configuration file used to find the representations for new samples now has a new format. Please refer to the documentation for a detailed explanation of the new format. The format is not backward compatible.

### Internal changes (for contributors)

* The '_get_data_loader()' method has been introduced into the 'core.model.DGDModel' class to create data loaders.

* There is now only one internal method in the 'core.model.DGDModel' class responsible for optimizing one or multiple representations for a set of samples, '_optimize_rep()'. The '_get_representations_one_opt()' and the '_get_representations_two_opt()' methods have been updated accordingly.

* New sanity checks have been introduced when loading configurations ('ioutil.configio' module).

* A new '_get_final_dataframes_train' method has been introduced to create the data frames produced by the new 'train()' method in the 'core.model.DGDModel' class.
  • Loading branch information
ValeSora committed Jul 7, 2024
1 parent 3fc0587 commit 49848d4
Show file tree
Hide file tree
Showing 38 changed files with 20,620 additions and 1,398 deletions.
9 changes: 0 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,3 @@ venv.bak/

# downloaded decoder
dec.pth

# only keep whitelisted set of config files
bulkDGD/ioutil/configs/*.yaml
!model.yaml
!pca_scatter.yaml
!r_values_hist.yaml
!time_line.yaml
!one_opt.yaml
!two_opt.yaml
Loading

0 comments on commit 49848d4

Please sign in to comment.