Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #179

Merged

Conversation

michaelbenayoun
Copy link
Member

@michaelbenayoun michaelbenayoun commented Sep 19, 2022

What does this PR do?

Updates and completes the optimum-graphcore documentation

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Sep 19, 2022

The documentation is not available anymore as the PR was closed or merged.

seed (`int`, *optional*):
Sets the seed for the random number generator on the IPU.
decompose_grad_sum (`bool`, *optional*, defaults to `False`):
[TODO] explains this easily
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jimypbr how would you explain this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh I think we should remove this option. It was added when experimenting with another model, but it didn't help with memory. It's not used in any of the models.

Enables caching the compile executables to a directory.
profile_dir (`str`, *optional*, defaults to `""`):
The directory to store debugging profiles.
[TODO] should we keep this?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jimypbr @gejinchen is it actually needed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no

@michaelbenayoun michaelbenayoun marked this pull request as ready for review October 6, 2022 15:19
@michaelbenayoun michaelbenayoun force-pushed the graphcore_documentation branch from 206148a to 47de666 Compare October 7, 2022 13:16
@michaelbenayoun michaelbenayoun force-pushed the graphcore_documentation branch from 47de666 to 500db89 Compare October 7, 2022 13:22
Copy link
Contributor

@jimypbr jimypbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great!

@michaelbenayoun michaelbenayoun merged commit 59c43f3 into huggingface:main Oct 7, 2022
@michaelbenayoun michaelbenayoun deleted the graphcore_documentation branch October 7, 2022 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants