Skip to content

Commit f63292b

Browse files
authored
DOC: Add core migration guide (#774)
* Add core migration guide * Remove markdown migration tracker in favor of GitHub project
1 parent ed1d909 commit f63292b

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

MIGRATED_TO_CORE.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

MIGRATION_TO_CORE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Migration From TF-Addons To TensorFlow Core
2+
3+
### In-Progress & Previous Migrations:
4+
https://github.com/tensorflow/addons/projects/2/
5+
6+
### Process
7+
1. Create an issue in TensorFlow Addons for a candidate that you think should be
8+
migrated.
9+
2. The SIG will evaluate the request and add it to the `Potential Candidates` section
10+
of our GitHub project.
11+
3. If it's agreed that a migration makes sense, an RFC needs to be written to discuss
12+
the move with a larger community audience.
13+
* Additions which subclass Keras APIs should submit their migration proposals to
14+
[Keras Governance](https://github.com/keras-team/governance)
15+
* Other additions should submit their migration proposals to
16+
[TensorFlow Community](https://github.com/tensorflow/community)
17+
4. If approved, a pull request must move the addition along with proper tests.
18+
5. After merging, the addition will be replaced with an alias to the core function
19+
if possible.
20+
6. If an alias is not possible (e.g. large parameter changes), then a deprecation
21+
warning will be added and eventual removed after 2 releases.
22+
23+
24+
### Criteria for Migration
25+
* The addition is widely used throughout the community
26+
* The addition is unlikely to have API changes as time progresses
27+
* The addition is well written / tested
28+

0 commit comments

Comments
 (0)