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 for current autograph support and sharp bits #6678

Merged
merged 133 commits into from
Dec 13, 2024
Merged

Conversation

lillian542
Copy link
Contributor

@lillian542 lillian542 commented Dec 5, 2024

  • Updates docstring for make_plxpr,
  • adds run_autograph to the capture module docs page
  • gives run_autograph a more comprehensive docstring, and
  • adds a sharp-bits guide for Autograph (currently only linked through the make_plxpr and run_autograph docstring)

[sc-71827]

@isaacdevlugt
Copy link
Contributor

My current understanding from @isaacdevlugt is that we want to link to it the relevant places (so its linked through the make_plxpr and run_autograph docstrings), but we don't want it showing up in the sidebar yet

Yep this is fine to be an internal document for now :)

Copy link
Contributor

@albi3ro albi3ro left a comment

Choose a reason for hiding this comment

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

My main concern is linking a document on stable instead of latest. This link will be broken till a release, and then always be a release out of date. This is also makes it hard to validate over time. But at the same time, I'm really not sure how to improve it. So I won't block for that.

Thanks for these docs 👍

Copy link
Contributor

@isaacdevlugt isaacdevlugt left a comment

Choose a reason for hiding this comment

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

Looks good from my side! 🚀

Copy link
Contributor

@astralcai astralcai left a comment

Choose a reason for hiding this comment

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

No further questions from me 🚀

@lillian542 lillian542 enabled auto-merge (squash) December 12, 2024 22:15
@lillian542 lillian542 added the merge-ready ✔️ All tests pass and the PR is ready to be merged. label Dec 12, 2024
@albi3ro albi3ro disabled auto-merge December 13, 2024 16:05
@albi3ro albi3ro merged commit 2c9d4c1 into master Dec 13, 2024
46 checks passed
@albi3ro albi3ro deleted the autograph_docs branch December 13, 2024 16:05
mudit2812 added a commit that referenced this pull request Dec 13, 2024
- Updates docstring for `make_plxpr`, 
- adds `run_autograph` to the capture module docs page 
- gives `run_autograph` a more comprehensive docstring, and 
- adds a sharp-bits guide for Autograph (currently only linked through
the `make_plxpr` and `run_autograph` docstring)

[sc-71827]

---------

Co-authored-by: andrijapau <[email protected]>
Co-authored-by: Christina Lee <[email protected]>
Co-authored-by: Mudit Pandey <[email protected]>
Co-authored-by: Pietropaolo Frisoni <[email protected]>
Co-authored-by: Yushao Chen (Jerry) <[email protected]>
Co-authored-by: Isaac De Vlugt <[email protected]>
Co-authored-by: Josh Izaac <[email protected]>
austingmhuang pushed a commit that referenced this pull request Dec 13, 2024
- Updates docstring for `make_plxpr`, 
- adds `run_autograph` to the capture module docs page 
- gives `run_autograph` a more comprehensive docstring, and 
- adds a sharp-bits guide for Autograph (currently only linked through
the `make_plxpr` and `run_autograph` docstring)

[sc-71827]

---------

Co-authored-by: andrijapau <[email protected]>
Co-authored-by: Christina Lee <[email protected]>
Co-authored-by: Mudit Pandey <[email protected]>
Co-authored-by: Pietropaolo Frisoni <[email protected]>
Co-authored-by: Yushao Chen (Jerry) <[email protected]>
Co-authored-by: Isaac De Vlugt <[email protected]>
Co-authored-by: Josh Izaac <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-ready ✔️ All tests pass and the PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants