Skip to content

Commit

Permalink
Fix note admonitions in "Custom Python function components" guide page
Browse files Browse the repository at this point in the history
  • Loading branch information
smokestacklightnin committed Sep 12, 2024
1 parent 87cd42e commit 4a7969e
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/guide/custom_function_component.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@ Under the hood, this defines a custom component that is a subclass of
[`BaseComponent`](https://github.com/tensorflow/tfx/blob/master/tfx/dsl/components/base/base_component.py){: .external }
and its Spec and Executor classes.

Note: the feature (BaseBeamComponent based component by annotating a function
with `@component(use_beam=True)`) described below is experimental and there is
no public backwards compatibility guarantees.
!!! Note
the feature (BaseBeamComponent based component by annotating a function
with `@component(use_beam=True)`) described below is experimental and there is
no public backwards compatibility guarantees.

If you want to define a subclass of
[`BaseBeamComponent`](https://github.com/tensorflow/tfx/blob/master/tfx/dsl/components/base/base_beam_component.py){: .external }
Expand Down Expand Up @@ -79,10 +80,11 @@ arguments and hyperparameters like training iteration count, dropout rate, and
other configuration to your component. Parameters are stored as properties of
component executions when tracked in ML Metadata.

Note: Currently, output simple data type values cannot be used as parameters
since they are not known at execution time. Similarly, input simple data type
values currently cannot take concrete values known at pipeline construction
time. We may remove this restriction in a future release of TFX.
!!! Note
Currently, output simple data type values cannot be used as parameters
since they are not known at execution time. Similarly, input simple data type
values currently cannot take concrete values known at pipeline construction
time. We may remove this restriction in a future release of TFX.

## Definition

Expand Down

0 comments on commit 4a7969e

Please sign in to comment.