Lightning-AI / Lightning-AI/pytorch-lightning

Batch size finder code example in dark mode is light instead of dark

Open
#20,530 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs tuner
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

### 📚 Documentation

On the [Batch size finder advanced tricks](https://lightning.ai/docs/pytorch/stable/advanced/training_tricks.html#batch-size-finder) page, in dark mode the example code is in light mode makes it hard to read:
Hard to read light mode code example
The code example should look instead look like this in dark mode:
Screenshot 2025-01-06 at 12 59 06 PM

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

Open the Batch size finder advanced tricks page at the linked training_tricks.html#batch-size-finder section and inspect how its code example and dark-mode styling are authored. Reproduce the page in dark mode, update the documented example or its styling so the code is readable, and verify that the example renders correctly in both light and dark modes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.