This page is about adding Markdown documentation files to GitHub. For more information on how to write the Markdown files in the first place, please see the writing model documentation guide.
Submitting the model
The complete Markdown files can be pulled into the master branch of tensorflow/hub.tensorflow.google.cn by one of the following methods.
Git CLI submission
Assuming the identified markdown file path is
assets/docs/publisher/model/1.md, you can follow the standard Git[Hub]
steps to create a new Pull Request with a newly added file.
This starts with forking the TensorFlow Hub GitHub repository, then creating a Pull Request from this fork into the TensorFlow Hub master branch.
The following are typical CLI git commands needed to adding a new file to a master branch of the forked repository.
git clone https://github.com/[github_username]/hub.tensorflow.google.cn.git cd hub.tensorflow.google.cn mkdir -p assets/docs/publisher/model cp my_markdown_file.md ./assets/docs/publisher/model/1.md git add * git commit -m "Added model file." git push origin master
GitHub GUI submission
- On the TensorFlow Hub GitHub page,
Create new filebutton.
- Set the right file path:
- Copy-paste the existing markdown.
- At the bottom, select "Create a new branch for this commit and start a pull request."