Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Some cleanups to the model spec documentation. #27

Closed
wants to merge 1 commit into from

Conversation

mdwelsh
Copy link
Contributor

@mdwelsh mdwelsh commented Jan 4, 2022

Clarify Android-only support for certain types.
Clean up descriptions of certain elements in the spec.
Fix a few typos.

Summary

The model spec documentation is confusing in a few cases, and some types are not supported on iOS (see #26).

Changelog

[DOCS] Improve model spec documentation

Test Plan

There are no code changes in this PR.

Clarify Android-only support for certain types.
Clean up descriptions of certain elements in the spec.
Fix a few typos.
@facebook-github-bot
Copy link
Contributor

Hi @mdwelsh!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 4, 2022
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link
Contributor

@raedle raedle left a comment

Choose a reason for hiding this comment

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

Thanks for submitting the PR and changes, @mdwelsh!!

We'll import the change for additional review and eventually merge your changes! Your contribution is very much appreciated!

@facebook-github-bot
Copy link
Contributor

@raedle has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@raedle
Copy link
Contributor

raedle commented Jan 5, 2022

We've merged the PR. Thanks again for your contributions, @mdwelsh!!

@raedle raedle added the 📚 documentation Improvements or additions to documentation label Jan 5, 2022
clarksandholtz pushed a commit that referenced this pull request Jan 19, 2022
Summary:
Clarify Android-only support for certain types.
Clean up descriptions of certain elements in the spec.
Fix a few typos.

The model spec documentation is confusing in a few cases, and some types are not supported on iOS (see #26).

## Changelog

[DOCS] Improve model spec documentation

Pull Request resolved: #27

Test Plan:
There are no code changes in this PR.

**Static Docs Preview: pytorch-live**
|[Full Site](https://our.intern.facebook.com/intern/staticdocs/eph/D33418396/V3/pytorch-live/)|

|**Modified Pages**|
|[docs/tutorials/model-spec](https://our.intern.facebook.com/intern/staticdocs/eph/D33418396/V3/pytorch-live/docs/tutorials/model-spec/)|
|[docs/api/model-spec](https://our.intern.facebook.com/intern/staticdocs/eph/D33418396/V3/pytorch-live/docs/api/model-spec/)|

Reviewed By: clarksandholtz

Differential Revision: D33418396

Pulled By: raedle

fbshipit-source-id: 1d154f4f58b1a634f5d3b732b05647a73e2a0208
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. 📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants