Skip to content

Enrich documentation for model users #488

@ai-mindset

Description

@ai-mindset

In order to

a) make it easier for a non-NHP model expert to get up and running with the model,
b) for new model devs to find their way through and maintain the code more easily (better bus factor),

it'd be useful to expand the README documentation with more detailed information on model setup, model usage, most important modules to look out for, idiosyncrasies we should be aware of and so on.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions