huggingface
missing online doc even though the docstring exists
https://huggingface.co/docs/accelerate/main/en/package_reference/accelerator?search=true doesn't seem to cover all the documented functions/methods.
e.g. searching for gather_object gives nada:
but the docstring is there: https://github.com/huggingface/accelerate/blob/d1abd59114ada8ba673e1214218cb2878c13b82d/src/accelerate/utils/operations.py#L417-L426
It does find gather on the other hand.
It seems that searching in accelerate docs does not work. Inputing "gather" does not return results, either.
Thanks for reporting.
It does find
gatheron the other hand.
There is an entry for gather here that generates an API reference, but gather_object is missing, which is why it doesn't show up. Not sure if there is any logic to which function is included and which isn't, probably this is just an oversight?@muellerzr
It seems that searching in accelerate docs does not work.
This seems to be a separate issue right now, we're investigating.
@BenjaminBossan yup there's some missing entries in the utils doc that need to be added. (We don't do everything for the utils, just what is in the __init__.py under utils/ but seems some are missing!)
@george-kuanli-peng The search feature in docs should be working correctly again.
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.
Please note that issues that do not follow the contributing guidelines are likely to be ignored.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Thanks Stas, yes indeed. A doc sprint is next on my list as we near 1.0.0 :)
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.
Please note that issues that do not follow the contributing guidelines are likely to be ignored.
unstale, this is still unresolved.
Interesting. There is now an entry in the API docs but it appears it's not being indexed. I tried a few of the other listed functions and they're also not indexed. We'll probably need someone who knows about the doc builder to take a look, maybe @mishig25?
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.
Please note that issues that do not follow the contributing guidelines are likely to be ignored.