huggingface / huggingface/doc-builder

Feature Request : Increase the depth of information displayed in the sidebar

Open
#733 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
144
Forks
59
Avg merge
2d 5h
Merged PRs (30d)
13

Description

Hey,

Everytime I'm browsing the docs of transformers or datasets, I struggle to find the methods of the class I am using. This is even harder for classes with many methods like [Dataset](https://huggingface.co/docs/datasets/package_reference/main_classes#datasets.Dataset).

IMO, It would be more convenient to have the list of methods for the classes, a bit like what is done in Lightning or TorchMetrics where you can expand to see the list and navigate straight to the one you are looking for. Also it helps to have a grasp of all the methods available in a given class.

[Lightning example](https://lightning.ai/docs/pytorch/stable/common/lightning_module.html#methods) :
Image

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.