tfl.utils.canonicalize_monotonicities
Stay organized with collections
Save and categorize content based on your preferences.
Converts string constants representing monotonicities into integers.
tfl.utils.canonicalize_monotonicities(
monotonicities, allow_decreasing=True
)
Args |
|---|
monotonicities
|
monotonicities hyperparameter of a tfl.layers Layer (e.g.
tfl.layers.Lattice).
|
allow_decreasing
|
If decreasing monotonicity is considered a valid
monotonicity.
|
Returns |
|---|
|
A list of monotonicities represented as -1, 0, 1, or the value None
if monotonicities is None.
|
Raises |
|---|
ValueError
|
If one of monotonicities is not in the set
{-1, 0, 1, 'decreasing', 'none', 'increasing'} and allow_decreasing is
True.
|
ValueError
|
If one of monotonicities is not in the set
{0, 1, 'none', 'increasing'} and allow_decreasing is False.
|
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-02 UTC.
[null,null,["Last updated 2024-08-02 UTC."],[],[],null,["# tfl.utils.canonicalize_monotonicities\n\n\u003cbr /\u003e\n\n|-------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/lattice/blob/v2.1.1/tensorflow_lattice/python/utils.py#L128-L154) |\n\nConverts string constants representing monotonicities into integers. \n\n tfl.utils.canonicalize_monotonicities(\n monotonicities, allow_decreasing=True\n )\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|--------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `monotonicities` | monotonicities hyperparameter of a [`tfl.layers`](../../tfl/layers) Layer (e.g. [`tfl.layers.Lattice`](../../tfl/layers/Lattice)). |\n| `allow_decreasing` | If decreasing monotonicity is considered a valid monotonicity. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A list of monotonicities represented as -1, 0, 1, or the value None if monotonicities is None. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------|\n| `ValueError` | If one of monotonicities is not in the set {-1, 0, 1, 'decreasing', 'none', 'increasing'} and allow_decreasing is True. |\n| `ValueError` | If one of monotonicities is not in the set {0, 1, 'none', 'increasing'} and allow_decreasing is False. |\n\n\u003cbr /\u003e"]]
View source on GitHub