GSTT-CSC / GSTT-CSC/project-template

End-to-end documentation

Open
#19 0 comments 0 reactions 1 assignee Claimed by @laurencejackson View on GitHub
documentation
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

We need to have good documentation for new users to be able to use this template effectively.

This will need to including guidance on the following:

- [x] introduction to the MLOps framework/components
- [x] introduction to the Project template components - run_project, entry points, Network, DataModule etc
- [ ] descriptions about what can be modified and what should not be changed.
- [ ] a worked example (e.g. carnax classifier)
- [ ] how to test locally and how to run on remote MLOps server

Please add any other key parts of this documentation below.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.