From f63292b8494e1bab142b870ca57ff70c716649db Mon Sep 17 00:00:00 2001 From: Sean Morgan Date: Fri, 20 Dec 2019 10:03:32 -0500 Subject: [PATCH] DOC: Add core migration guide (#774) * Add core migration guide * Remove markdown migration tracker in favor of GitHub project --- MIGRATED_TO_CORE.md | 8 -------- MIGRATION_TO_CORE.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 8 deletions(-) delete mode 100644 MIGRATED_TO_CORE.md create mode 100644 MIGRATION_TO_CORE.md diff --git a/MIGRATED_TO_CORE.md b/MIGRATED_TO_CORE.md deleted file mode 100644 index e1aad6645a..0000000000 --- a/MIGRATED_TO_CORE.md +++ /dev/null @@ -1,8 +0,0 @@ -# Migrated To TensorFlow Core - -| Function | Status | Last TFA Version | First TF Version | Relevant PRs | -|:-------- |:------ |:---------------- |:---------------- |:-------------| -| [metrics.F1Score](https://github.com/tensorflow/addons/blob/r0.5/tensorflow_addons/metrics/f_scores.py#L255) & [metrics.FBetaScore](https://github.com/tensorflow/addons/blob/r0.5/tensorflow_addons/metrics/f_scores.py#L26) | In Progress | | | [TF-31818](https://github.com/tensorflow/tensorflow/pull/31818) & [TFA-430](https://github.com/tensorflow/addons/issues/430) | -| [utils.register_keras_custom_object](https://github.com/tensorflow/addons/blob/r0.5/tensorflow_addons/utils/keras_utils.py#L23) | In Progress | | | [TFA-438](https://github.com/tensorflow/addons/issues/438) | -| [activations.gelu](https://github.com/tensorflow/addons/blob/r0.5/tensorflow_addons/activations/gelu.py#L30) | Proposed | | | [TFA-550](https://github.com/tensorflow/addons/issues/550) | - diff --git a/MIGRATION_TO_CORE.md b/MIGRATION_TO_CORE.md new file mode 100644 index 0000000000..2efe44f14f --- /dev/null +++ b/MIGRATION_TO_CORE.md @@ -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 +* The addition is unlikely to have API changes as time progresses +* The addition is well written / tested +