Lightning-AI / Lightning-AI/pytorch-lightning

CSVLogger missing information about yaml

Open
#20,724 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

📚 Documentation

The CSVLogger claims to "Log to local file system in yaml and CSV format" but missing any usually information on how to configure it for yaml?

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

Start from the linked CSVLogger API documentation and inspect its current description and configuration examples. Document how YAML output is configured, then verify the rendered API page clearly explains the available behavior and usage.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.