Save the date! Google I/O returns May 18-20 Register now

Contribute a model

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/tfhub.dev 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]/tfhub.dev.git
cd tfhub.dev
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

A somewhat more straightforward way of submitting is via GitHub graphical user interface. GitHub allows creating PRs for new files or file edits directly through GUI.

  1. On the TensorFlow Hub GitHub page, press Create new file button.
  2. Set the right file path: assets/docs/publisher/model/1.md
  3. Copy-paste the existing markdown.
  4. At the bottom, select "Create a new branch for this commit and start a pull request."