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

Create docs/tutorial/ consistent with other TF projects #227

Closed
missaugustina opened this issue May 8, 2019 · 8 comments
Closed

Create docs/tutorial/ consistent with other TF projects #227

missaugustina opened this issue May 8, 2019 · 8 comments
Assignees

Comments

@missaugustina
Copy link

Per mailing list conversation (https://groups.google.com/a/tensorflow.org/forum/#!topic/io/ctHeERQj5nw) we should create a docs/tutorials directory to house Colab Jupyter notebooks.

Please assign this issue to me, I'm working on a tutorial for the change referenced in the mailing list link above - #30

@yongtang
Copy link
Member

yongtang commented May 8, 2019

@missaugustina Assigned to you, thanks!

@missaugustina
Copy link
Author

missaugustina commented May 15, 2019

  • look at other projects for examples of this directory structure

Other projects store these in docs starting from the parent level directory of the repository. The use of the "tutorials" directory is less consistent for projects following this structure.

tensorflow/tensorboard - https://github.com/tensorflow/tensorboard/tree/master/docs

  • .yamllint
  • _book.yaml
  • _index.yaml
  • _project.yaml

tensorflow/tfx - https://github.com/tensorflow/tfx/tree/master/docs/tutorials

  • _index.yaml
  • _toc.yaml

tensorflow/tensor2tensor - https://github.com/tensorflow/tensor2tensor/tree/master/docs/tutorials

  • asr_with_transformer.md "Add a placeholder to link to the official ASR tutorial"

tensorflow/datasets - https://github.com/tensorflow/datasets/tree/master/docs

  • a mix of markdown & yaml files

@missaugustina
Copy link
Author

missaugustina commented May 15, 2019

  • determine best initial stub document

Because other projects consistently use markdown, I'm going to initialize this new directory structure with a README.md file with instructions for creating & submitting a tutorial.

  • find other Tensorflow tutorials using Colab & Jupyter from the repos listed above
  • reverse engineer how they got into the repo & document the steps

Questions to sort out:

Per Apache 2 license, a copyright holder must be listed & this is in the template. I've asked who "Tensorflow authors" refers to.

edit: Tensorflow authors is covered by the CLA. The author submitting the content would qualify as a Tensorflow author.

@missaugustina
Copy link
Author

Create Readme document with the following sections:

  • What content makes sense
  • How to submit
  • Formats (maybe just cover Jupyter to start)

@lamberta
Copy link
Member

Looks like there's work on the landing page here: #498
and would be great to get some notebooks that we can pull into tensorflow.org (similiar to the tf-addons notebook tutorials).

Would like to link off to this from the main tutorials section, so these load_data notebooks might provide a useful starting point.

cc: @MarkDaoust

@MarkDaoust
Copy link
Member

There's one notebook in the works here: #591, I've given some feedback on how they can integrate with the tensorflow.org setup.

@kvignesh1420
Copy link
Member

@yongtang can this be closed?

@yongtang
Copy link
Member

yongtang commented Nov 8, 2020

@kvignesh1420 Thanks yes this can be closed now.

@yongtang yongtang closed this as completed Nov 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants