Skip to content

DOC: Add core migration guide #774

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 20, 2019
Merged

DOC: Add core migration guide #774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9bda87
* Add core migration guide
seanpmorgan Dec 14, 2019
8a6097a
typo
seanpmorgan Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions MIGRATED_TO_CORE.md
View file
Open in desktop

This file was deleted.

28 changes: 28 additions & 0 deletions MIGRATION_TO_CORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Migration From TF-Addons To TensorFlow Core

### In-Progress & Previous Migrations:
https://github.com/tensorflow/addons/projects/2/

### Process
1. Create an issue in TensorFlow Addons for a candidate that you think should be
migrated.
2. The SIG will evaluate the request and add it to the `Potential Candidates` section
of our GitHub project.
3. If it's agreed that a migration makes sense, an RFC needs to be written to discuss
the move with a larger community audience.
* Additions which subclass Keras APIs should submit their migration proposals to
[Keras Governance](https://github.com/keras-team/governance)
* Other additions should submit their migration proposals to
[TensorFlow Community](https://github.com/tensorflow/community)
4. If approved, a pull request must move the addition along with proper tests.
5. After merging, the addition will be replaced with an alias to the core function
if possible.
6. If an alias is not possible (e.g. large parameter changes), then a deprecation
warning will be added and eventual removed after 2 releases.


### Criteria for Migration
* The addition is widely used throughout the community
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have any kind of telemetry?

Copy link
Member Author

Choose a reason for hiding this comment

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

#236 needs to be completed. We were/are waiting for adoption to pick up along with TF2 adoption:
https://pypistats.org/packages/tensorflow-addons

* The addition is unlikely to have API changes as time progresses
* The addition is well written / tested