Lightning-AI / Lightning-AI/pytorch-lightning

Can we have an LLM.txt?

Open
#20,758 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

discussion feature question
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

### Description & Motivation

Can we have an LLM.txt? which can instruct most LLMs how to refactor their code according to lightning with overarching examples? Especially for callbacks this would be super useful allowing us to port models faster.

### Pitch

_No response_

### Alternatives

_No response_

### Additional context

_No response_

cc @lantiga @borda

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue. First clarify the scope and expected contents of an LLM.txt, including the callback refactoring guidance and overarching examples; done would be a reviewed file that provides actionable instructions for porting models.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.