ChEB-AI / python-chebai

GNU Affero General Public License v3.0

11 stars 4 forks source link

Code needs to be documented #9

Closed sfluegel05 closed 1 month ago

sfluegel05 commented 6 months ago

Tasks

Annotate code with docstrings
- as an orientation, use the docstrings used by PyTorch Lightning
Where possible, also add type hints to function signatures

Later on: integrate into readthedocs

sfluegel05 commented 3 months ago

some docstrings have been added in #19

sfluegel05 commented 2 months ago

There are still missing docstrings for many classes. To improve the coverage, I would suggest to prioritize and leave out some classes that are currently not used. These include

models (except for base and electra)
datasets with a JCI prefix
files in the results folder (except for utils and classification)

aditya0by0 commented 2 months ago

Can you please tell me do we need to leave out the classes ElectraLegacy, ConeElectra, ConeLoss in chebai/models/electra.py as it seems they are also not used in anywhere in configs

Also all the classes in file chebai/preprocessing/collect_all.py

sfluegel05 commented 2 months ago

You can leave those classes out, as they are (probably) not in use at the moment. We can still document them later when the need arises.