Lightning-AI / Lightning-AI/litgpt
Docs for non-cli usage
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13.7k
- Forks
- 1.5k
- Avg merge
- 15h 37m
- Merged PRs (30d)
- 1
Description
Thanks for the great lib!
My only gripe is that the documentation and tutorials only show how to use this lib as a cli. I want to do some very custom stuff in the future so id like to use it as python code.
Are there any tutorials for doing so? If not, may I know why its only meant to be used as a CLI?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing documentation and tutorials to map what is currently covered for CLI usage and whether Python-code usage is documented. Define the supported non-CLI workflow, then add tutorials explaining it or document why the library is intended only for CLI use; the documentation should answer the request without requiring readers to infer the API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100