huggingface/lighteval

[FT] Improve Documentation and Examples

Open

#682 opened on Apr 21, 2025

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Python (514 forks)auto 404
documentationfeaturegood first issuehelp wanted

Repository metrics

Stars
 (2,496 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue encountered

We need better documentation for locally trained LLMs. I am experimenting with finetunes and LoRA adapters but I am having a bad time ironing out the required values for the yaml config.

Solution/Feature

Provide working examples for adapter configurations.

Possible alternatives

Make the library more coherent? --override-batch-size no longer works but it is still available under lighteval accelerate.

Contributor guide

Research direction
Review existing adapter configuration examples in the repository and documentation. Identify missing pieces and create clear, working examples for LoRA adapters.
Tech stack
python
Domain
ai
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75