Add a warning to all FeatureColumn functions.

This change adds a deprecation warning to the FeatureColumn API that encourages migration to Keras preprocessing layers instead (with a link) and also links the user to the TF2 migration guide.

PiperOrigin-RevId: 483785240

Author: nkovela1

tools/tensorflow_docs/api_generator/doc_controls.py

@@ -35,20 +35,25 @@ def is_deprecated(obj) -> bool:
 
 def inheritable_header(text: str):
 
-  def _wrapped(cls):
-    setattr(cls, _INHERITABLE_HEADER, text)
-    return cls
+  def _wrapped(obj):
+    setattr(obj, _INHERITABLE_HEADER, text)
+    return obj
 
   return _wrapped
 
 
-def get_inheritable_header(cls) -> Optional[str]:
-  return getattr(cls, _INHERITABLE_HEADER, None)
+def get_inheritable_header(obj) -> Optional[str]:
+  return getattr(obj, _INHERITABLE_HEADER, None)
+
+
+header = inheritable_header
+get_header = get_inheritable_header
 
 
 _NO_SEARCH_HINTS = "_tf_docs_no_search_hints"
 
 
+
 def hide_from_search(obj: T) -> T:
   """Marks an object so metadata search hints will not be included on it's page.
 

tools/tensorflow_docs/api_generator/pretty_docs/function_page.py

@@ -12,8 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-from typing import Any
+import textwrap
+from typing import Any, Optional
 
+from tensorflow_docs.api_generator import doc_controls
 from tensorflow_docs.api_generator import parser
 from tensorflow_docs.api_generator import signature as signature_lib
 from tensorflow_docs.api_generator.pretty_docs import base_page
@@ -86,5 +88,12 @@ def decorators(self):
   def add_decorator(self, dec):
     self._decorators.append(dec)
 
+  @property
+  def header(self) -> Optional[str]:
+    header = doc_controls.get_header(self.py_object)
+    if header is not None:
+      header = textwrap.dedent(header)
+    return header
+
   def get_metadata_html(self):
     return parser.Metadata(self.full_name).build_html()

tools/tensorflow_docs/api_generator/pretty_docs/templates/function.jinja

@@ -1,5 +1,23 @@
 {% extends "templates/page.jinja" %}
 
+{#----------------------------------------------------------------------------#}
+
+{% block metadata %}
+{{ builder.top_source_link() }}
+
+{{ page_info.doc.brief }}
+
+{% if page_info.header %}
+
+
+{{ page_info.header -}}
+{% endif %}
+
+{{ builder.build_collapsable_aliases() -}}
+{% endblock metadata %}
+
+{#----------------------------------------------------------------------------#}
+
 {% block body %}
 {% if page_info.signature %}
 {{ builder.build_signature() }}