Skip to content
This repository was archived by the owner on Jul 7, 2023. It is now read-only.

Documentation for creating own model #1589

Merged
merged 4 commits into from
Jun 7, 2019

Conversation

hbrylkowski
Copy link
Contributor

I've written docs that were marked as TODO for a long time.
Most of them are copied from appropriate places in the repository, but I think for someone who just starts with t2t it will be easier having it all in one place.
Also I've changed Contributions link to absolute one since it was 404'ing from docs directory.

@googlebot googlebot added the cla: yes PR author has signed CLA label May 29, 2019
@@ -5,12 +5,103 @@ version](https://badge.fury.io/py/tensor2tensor.svg)](https://badge.fury.io/py/t
[![GitHub
Issues](https://img.shields.io/github/issues/tensorflow/tensor2tensor.svg)](https://github.com/tensorflow/tensor2tensor/issues)
[![Contributions
welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/tensorflow/CONTRIBUTING.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

This link does not exist. Use ../CONTRIBUTING.md (or https://github.com/tensorflow/tensor2tensor/blob/master/CONTRIBUTING.md if absolute path is needed for some reason)

@afrozenator
Copy link
Contributor

This is really really awesome, thanks a LOT @hbrylkowski !

@afrozenator afrozenator merged commit cb76e97 into tensorflow:master Jun 7, 2019
tensorflow-copybara pushed a commit that referenced this pull request Jun 7, 2019
PiperOrigin-RevId: 252130487
@hbrylkowski
Copy link
Contributor Author

@afrozenator - It's really good to hear that :) If I wanted to expand documentation further where would you say it is needed the most right now? I thought about documenting all models and datasets - extracting it from pydoc in model/dataset class, and then possibly add it to build so it would appear in docs automatically.

@afrozenator
Copy link
Contributor

Thanks again a lot for doing this @hbrylkowski , I'm adding @lukaszkaiser for more thoughts on this, but I'd say leave out datasets for now, since the long term plan is for that to live in https://www.tensorflow.org/datasets completely.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes PR author has signed CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants