diff --git a/sigs/addons/MIGRATION_RFC_TEMPLATE.md b/sigs/addons/MIGRATION_RFC_TEMPLATE.md new file mode 100644 index 000000000..d20606363 --- /dev/null +++ b/sigs/addons/MIGRATION_RFC_TEMPLATE.md @@ -0,0 +1,41 @@ +# Migrate XXXXX from TensorFlow Addons to TensorFlow Core + +| Status | Proposed (Waiting for Sponsor) | +| :---------- | :------------------------------------------------------------------------------------------------- | +| **RFC #** | TBD after PR | | +| **Authors** | XXXXXXXXXX | +| **Sponsor** | XXXXXXXXXX | +| **Updated** | YYYY-MM-DD | +| **Sponsorship Deadline** | YYYY-MM-DD (45 Days after submission) | + +## Rationale for Migration +* What are the use cases for the addon? +* OSS usage, H5 Index, etc. + +## Historical Information +* Have there been signifiant issues reported to Addons that need to be adressed? +* When was it implemented in Addons? + +## Implementation Details +* Link to implementation in Addons: +* Does this include custom-op kernels? + * Are they CPU/GPU/TPU compatible? +* What is the pytest coverage of the addon? + +## Changes to Implementation (If Needed) +``` +Code snippet(s) showing proposed code changes +``` +* Discussion on the rationale for changes + +## Transition Plan +* Proposed landing place in tf-core +* Will there be any changes to the API? (e.g. additional parameters or renaming) +* Deprecation plan for Addons + +## Relevant GitHub Issues + +## Questions and Discussion Topics + +## Final Decision +TBD diff --git a/sigs/addons/MIGRATION_TO_CORE.md b/sigs/addons/MIGRATION_TO_CORE.md new file mode 100644 index 000000000..e7f7be129 --- /dev/null +++ b/sigs/addons/MIGRATION_TO_CORE.md @@ -0,0 +1,33 @@ +# 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. + * If the transition will impact tf-core and Keras then submit the RFC to + [TensorFlow Community](https://github.com/tensorflow/community) + * Additions which only subclass Keras APIs should submit their migration proposals to + [Keras Governance](https://github.com/keras-team/governance) + +4. A sponsor from the TF/Keras team must agree to shepard the transition and maintain +the new API in tensorflow/tensorflow. + * If no sponsor is obtained after 45 days the RFC will be rejected and will remain + as part of Addons. +5. If a sponsor is obtained, and the RFC is approved, a pull request must move the +addon along with proper tests. +6. After merging, the addition will be replaced with an alias to the core function +if possible. If an alias is not possible (e.g. large parameter changes), then a deprecation +warning will be added and will be removed from TFA after 2 releases. + + +### Criteria for Migration RFC +* The addition is widely used throughout the community, or has high academic significance. + * Metrics must be reported in the RFC (OSS usage, H5 index, etc.) +* The addition is unlikely to have API changes as time progresses +* The addition is well written / tested