# tff.to_value

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |

Converts the argument into an instance of the abstract class [`tff.Value`](https://www.tensorflow.org/federated/api_docs/python/tff/Value).

    tff.to_value(
        arg: object,
        type_spec: Optional[https://www.tensorflow.org/federated/api_docs/python/tff/types/Type],
        *,
        parameter_type_hint=None,
        zip_if_needed: bool = False
    ) -> https://www.tensorflow.org/federated/api_docs/python/tff/Value

Instances of [`tff.Value`](https://www.tensorflow.org/federated/api_docs/python/tff/Value) represent TFF values that appear internally in
federated computations. This helper function can be used to wrap a variety of
Python objects as [`tff.Value`](https://www.tensorflow.org/federated/api_docs/python/tff/Value) instances to allow them to be passed as
arguments, used as functions, or otherwise manipulated within bodies of
federated computations.

At the moment, the supported types include:

- Simple constants of `str`, `int`, `float`, and `bool` types, mapped to
  values of a TFF tensor type.

- Numpy arrays (`np.ndarray` objects), also mapped to TFF tensors.

- Dictionaries (`collections.OrderedDict` and unordered `dict`), `list`s,
  `tuple`s, `namedtuple`s, and `Struct`s, all of which are mapped to
  TFF tuple type.

- Computations (constructed with either the [`tff.tensorflow.computation`](https://www.tensorflow.org/federated/api_docs/python/tff/tensorflow/computation) or
  with the [`tff.federated_computation`](https://www.tensorflow.org/federated/api_docs/python/tff/federated_computation) decorator), typically mapped to TFF
  functions.

- Placement literals ([`tff.CLIENTS`](https://www.tensorflow.org/federated/api_docs/python/tff#CLIENTS), [`tff.SERVER`](https://www.tensorflow.org/federated/api_docs/python/tff#SERVER)), mapped to values of the
  TFF placement type.

This function is also invoked when attempting to execute a TFF computation.
All arguments supplied in the invocation are converted into TFF values prior
to execution. The types of Python objects that can be passed as arguments to
computations thus matches the types listed here.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `arg` | An instance of one of the Python types that are convertible to TFF values (instances of [`tff.Value`](https://www.tensorflow.org/federated/api_docs/python/tff/Value)). |
| `type_spec` | An optional type specifier that allows for disambiguating the target type (e.g., when two TFF types can be mapped to the same Python representations). If not specified, TFF tried to determine the type of the TFF value automatically. |
| `parameter_type_hint` | An optional [`tff.Type`](https://www.tensorflow.org/federated/api_docs/python/tff/types/Type) or value convertible to it by [`tff.to_type()`](https://www.tensorflow.org/federated/api_docs/python/tff/types/to_type) which specifies an argument type to use in the case that `arg` is a `polymorphic_computation.PolymorphicComputation`. |
| `zip_if_needed` | If `True`, attempt to coerce the result of `to_value` to match `type_spec` by applying `intrinsics.federated_zip` to appropriate elements. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| An instance of [`tff.Value`](https://www.tensorflow.org/federated/api_docs/python/tff/Value) as described above. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `TypeError` | if `arg` is of an unsupported type, or of a type that does not match `type_spec`. Raises explicit error message if TensorFlow constructs are encountered, as TensorFlow code should be sealed away from TFF federated context. |

<br />