Skip to content

Code needs to be documented #9

Closed

Description

@sfluegel05

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

Activity

  1. sfluegel05 commented on May 29, 2024

    @sfluegel05
    CollaboratorAuthor

    some docstrings have been added in #19

  2. sfluegel05 commented on Jun 13, 2024

    @sfluegel05
    CollaboratorAuthor

    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)
  3. aditya0by0 commented on Jun 24, 2024

    @aditya0by0
    Member

    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

  4. sfluegel05 commented on Jun 25, 2024

    @sfluegel05
    CollaboratorAuthor

    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.

  5. linked a pull request that will close this issueCode documentation #35on Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions