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

Initial setup for tensorflow subsite #486

Open
wants to merge 5 commits into
base: master
from

Conversation

@seanpmorgan
Copy link
Member

commented Sep 9, 2019

Starting a PR to close #226

@seanpmorgan seanpmorgan requested a review from tensorflow/sig-addons-maintainers as a code owner Sep 9, 2019

@googlebot googlebot added the cla: yes label Sep 9, 2019

@seanpmorgan
Copy link
Member Author

left a comment

It's difficult to check that these links are working correctly... Is it possible for the Docs team to test this PR or show us how to do that as a webpage?

Also, I didn't immediately see why overview.md and bar_guide.md are part of the template directory. Are these required?

docs/_book.yaml Outdated Show resolved Hide resolved
docs/_book.yaml Show resolved Hide resolved
docs/_index.yaml Show resolved Hide resolved
@seanpmorgan

This comment has been minimized.

Copy link
Member Author

commented Sep 9, 2019

Granted the docs team write permission as well.

seanpmorgan added 3 commits Sep 9, 2019

@seanpmorgan seanpmorgan changed the title [WIP] Initial setup for tensorflow subsite Initial setup for tensorflow subsite Sep 10, 2019

@seanpmorgan

This comment has been minimized.

Copy link
Member Author

commented Sep 10, 2019

@lamberta @MarkDaoust changes made, thanks! What would be the path forward for testing this?

@lamberta

This comment has been minimized.

Copy link
Member

commented Sep 10, 2019

Great, thanks.
As far as testing notebooks, @yashk2810 has some CI set up in the tensorflow/docs repo. Not sure of the plan to extend that to other repos, but would be cool.
As far as full staging and previews, I don't think that's possible with our internal site infra. But if it works in the GitHub Markdown previewer and in Colab, then it should render fine on tensorflow.org. But if there's a launch or something, you can ping me (or someone) to stage internally and double check things.

CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/_book.yaml Outdated Show resolved Hide resolved

@lamberta lamberta requested a review from MarkDaoust Sep 10, 2019

- title: Triplet loss
path: /addons/tutorials/losses_triplet
- title: Image Ops
path: /addons/tutorials/image_ops

This comment has been minimized.

Copy link
@seanpmorgan

seanpmorgan Sep 10, 2019

Author Member

@lamberta So this part I'm still unclear on. Where does the directory "addons" come from? Is it just the repository name?

Does it need to be addons/docs/tutorials/*?

This comment has been minimized.

Copy link
@MarkDaoust

MarkDaoust Sep 10, 2019

"/addons/tutorials/losses_triplet" is correct.

The workflow is "take a directory and put it on the site". Addons is just the name for this directory on the site.

So we'll set up the tools to take "https://github.com/tensorflow/addons/tree/master/docs" and put it on the site as "tensorflow.org/addons".

So two things to remember about links for that:

  1. Use relative links when linking between files within the directory (so users keep their github/colab/tensorflow.org context). Use full URLs if you need to link to something outside of the directory. Never use absolute path links.

  2. In notebooks and markdown tfa.thing will be auto-linked to the appropriate api-page, if it exists.

This comment has been minimized.

Copy link
@seanpmorgan

seanpmorgan Sep 12, 2019

Author Member

Great thanks. So just to be clear will the utilized directory always come from master branch? At the moment we only generate docs for our release branches, but that'd probably require you pulling down a new directory for each release.

@yashk2810

This comment has been minimized.

Copy link
Member

commented Sep 12, 2019

As far as testing notebooks, @yashk2810 has some CI set up in the tensorflow/docs

Since a subsite is being created for addons, the notebooks will automatically get tested with the pipeline. If something fails, we will send an email to the addons team about the failure.

But there are a few things to keep in mind.

  1. We test with TF2 and python3 by default. There are other options but it's not enabled by default.
  2. Please follow the template
    https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb to write the notebooks if it's not being written in this format.

Can you add the team's email where we can send the emails about failures?

@facaiy

This comment has been minimized.

Copy link
Member

commented Sep 15, 2019

@yashk2810 please send failure to addons-testing@tensorflow.org , thanks, Yash!

  1. We test with TF2 and python3 by default.

I'm fine, what do you think, Sean?

  1. Please follow the template

Will do, thanks

@facaiy

This comment has been minimized.

Copy link
Member

commented Sep 15, 2019

One more question, can we test notebook for master branch (I mean, tfa-nightly version)?

@yashk2810

This comment has been minimized.

Copy link
Member

commented Sep 15, 2019

I mean, tfa-nightly

Yes, the infra will install whatever version you install in the notebook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.