Add docstring docs - Githubissues

huggingface / lighteval

Lighteval is your all-in-one toolkit for evaluating LLMs across multiple backends

MIT License

851 stars 100 forks source link

Add docstring docs #413

Open albertvillanova opened 2 days ago

albertvillanova commented 2 days ago

Add docstring docs.

I see this PR as setting up the docs for classes/functions using their docstrings.

Future PRs could add missing docstrings and improve the existing ones, if needed.

albertvillanova commented 2 days ago

There is an incompatibility issue within the lighteval[dev] environment while generating the docs:

thinc-8.2.4 requires numpy<2
numpy-2.1.3 is installed
apparently there is a package that removed the requirement numpy<2

https://github.com/huggingface/lighteval/actions/runs/12084402368/job/33699519327?pr=413

   File "thinc/backends/numpy_ops.pyx", line 1, in init thinc.backends.numpy_ops
ValueError: numpy.dtype size changed, may indicate binary incompatibility. Expected 96 from C header, got 88 from PyObject

I pin numpy < 2.

HuggingFaceDocBuilderDev commented 2 days ago

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

albertvillanova commented 2 days ago

Preliminary docs with docstrings (well, we need to add the docstrings): https://moon-ci-docs.huggingface.co/docs/lighteval/pr_413/en/package_reference/pipeline

albertvillanova commented 1 day ago

Maybe we should rename the section "API" (with available metrics and tasks) to avoid confusion with the "Reference" section (containing the docstrings of classes/functions).

albertvillanova commented 1 day ago

Ready for review:

I see this PR as setting up the docs for classes/functions using their docstrings.
Future PRs could add missing docstrings and improve the existing ones, if needed.