MDX Errors when trying to contribute to transformer's model cards.
Ubuntu 24.04.2 LTS, CPython 3.11.12, transformers==4.53.0.dev0
I'm trying to contribute to the model cards. I forked the latest transformers and I ran the scripts, from the home page and then I want to the documents page. I'm having issues with the doc builder. I keep receiving the errors "ValueError: There was an error when converting docs/source/en/internal/generation_utils.md to the MDX format.
Unable to find generation.TFGreedySearchEncoderDecoderOutput in transformers. Make sure the path to that object is correct." And Unable to find image_processing_utils_fast.BaseImageProcessorFast in transformers. Make sure the path to that object is correct.
I ran the " pip install -e ".[docs]" and saw this after installing everything: "warning: The package transformers @ file://s does not have an extra named docs"
I ran the doc builder and that ran as expected until I ran the doc-builder command "doc-builder build transformers docs/source/en/ --build_dir ~/tmp/test-build"
Is there something that I'm misunderstanding? Is there a workaround for me to write the markdown of the card that I have been assigned without having to run those scripts instead, in the meantime. Sorry for the bother, this is my first time experience with the repo and I'm probably missing a step! Thank you!
Hey @Mdrnfox , for documentation contributions, I would advise opening a PR on the repo and checking the doc-builder run. AFAIK, running the doc-builder requires all dependencies installed (here, it seems it's erroring out as you don't have TensorFlow installed).
You could try installing all dependencies by running
pip install -e .[dev]
But if you just want to double check that what you did is as you expect, opening a PR and waiting for the doc building job to finish is a good way to do so.