tfma.metrics.Preprocessor.SetupContextParam
Stay organized with collections
Save and categorize content based on your preferences.
Allows one to use a context manager to manage DoFn-scoped parameters.
tfma.metrics.Preprocessor.SetupContextParam(
context_manager_constructor, args=(), kwargs=None, *, name=None
)
The context will be entered before the DoFn is used and exited when it is
discarded, equivalent to the setup
and teardown
methods of a DoFn.
(Note, like teardown
, exiting is best effort, as workers may be killed
before all DoFns are torn down.)
The object returned from __enter__
, if any, will be substituted for this
parameter in invocations. Multiple context manager parameters may be
specified which will all be evaluated (in an unspecified order).
This can be useful for setting up shared resources like persistent
connections to external services for transforms like Map
, FlatMap
, and
Filter
where one does not have setup and teardown methods.
Methods
create_and_enter
create_and_enter()
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-16 UTC.
[null,null,["Last updated 2024-08-16 UTC."],[],[],null,["# tfma.metrics.Preprocessor.SetupContextParam\n\n\u003cbr /\u003e\n\nAllows one to use a context manager to manage DoFn-scoped parameters.\n\n#### View aliases\n\n\n**Main aliases**\n\n[`tfma.utils.DoFnWithModels.SetupContextParam`](https://www.tensorflow.org/tfx/model_analysis/api_docs/python/tfma/metrics/Preprocessor/SetupContextParam)\n\n\u003cbr /\u003e\n\n tfma.metrics.Preprocessor.SetupContextParam(\n context_manager_constructor, args=(), kwargs=None, *, name=None\n )\n\nThe context will be entered before the DoFn is used and exited when it is\ndiscarded, equivalent to the `setup` and `teardown` methods of a DoFn.\n(Note, like `teardown`, exiting is best effort, as workers may be killed\nbefore all DoFns are torn down.)\n\nThe object returned from `__enter__`, if any, will be substituted for this\nparameter in invocations. Multiple context manager parameters may be\nspecified which will all be evaluated (in an unspecified order).\n\nThis can be useful for setting up shared resources like persistent\nconnections to external services for transforms like `Map`, `FlatMap`, and\n`Filter` where one does not have setup and teardown methods.\n\nMethods\n-------\n\n### `create_and_enter`\n\n create_and_enter()"]]