marrlab / DomainLab

modular domain generalization: https://pypi.org/project/domainlab/
https://marrlab.github.io/DomainLab/
MIT License
40 stars 2 forks source link

write more documentation for taskfolder #817

Closed smilesun closed 2 months ago

smilesun commented 2 months ago

the argument dict_domain_folder_name2class is connecting folder name to class anme,

the key should be folder name

https://github.com/marrlab/DomainLab/blob/56cf5a2fd015e4222f93ced91e7f1bed4d675bef/examples/tasks/task_blood3.py#L78C30-L78C40

According to implementation here DomainLab/domainlab/tasks/task_folder.py

Line 85 in 56cf5a2

domain_class_dirs = self._dict_domain_folder_name2class[na_domain].keys()

but we made the mistake of aving wrong key-value order in the old commit here

https://github.com/marrlab/DomainLab/commit/332b9f987bbddfae13536840aefae95312c691d3

we need to document properly so that the user won't make similar mistakes in https://github.com/marrlab/DomainLab/blob/master/examples/tasks/task_blood3.py