Skip to content

Code structure and quality #28

@philipnickel

Description

@philipnickel
  • Ensure docstrings are up to date
  • Ensure the API_reference.rst is up to date
  • Better structure of Poisson/ module
  • Better use of 'internal' Functions that are not 'exposed' in init.py
    • For Only 'exposed' functions and classes should be documented with sphinx. (autosummary)
    • For classes for example: Internal functions/methods shoudl be at the bottom.
  • /Users/philipnickel/Documents/GitHub/DTU_Courses/LargeScaleModeling/LSM/LSM-Project_2/src/utils/plotting/palettes.py is redundant.
  • consistent plot usage to use consistent figure sizes and so on.
  • Instead of renaming columns in dfs for plotting: Name better from the start and just plot directly.
  • Ensure stdout and stderr are ALWAYS logged as artifacts to mlflow no matter what. (flush)
  • Ensure mlflow run is started before rest of program (without system metrics logging)
  • Is allgather (lower case) inefficient?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions