Lightning-AI / Lightning-AI/LitModels

Doc links take nowhere

Open
#128 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
40
Forks
9
PR merge metrics
No merged PRs in 30d

Description

I got a hint printed when running a `lightning.Trainer` object, which sent me to the `PyPi` page for litModels. There is a link to documentation there which points to the non-existing https://lightning-ai.github.io/litModels/

Coming to the repo here in GitHub, the "Docs" link in the readme points at
https://lightning.ai/docs/overview/model-registry

which also doesn't seem to exist, and redirects to the "getting started" documentation for pytorch lightning.

I find it very bad manners to use one product to advertise another, and I find it particularly annoying when said advertised product is not even properly documented. Please set a proper documentation place for this project, or otherwise stop plugging it into other projects until there is a reasonable way of reading what the suggestion is about.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by checking the documentation links in the README, the PyPI page for litModels, and the hint printed by a lightning.Trainer object. Determine whether this project has a supported documentation location or whether the references should be removed; done means the remaining links resolve to relevant project documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.