values is a string containing comma-separated name=value pairs.
For each pair, the value of the hyperparameter named name is set to
value.
If a hyperparameter name appears multiple times in values, a ValueError
is raised (e.g. 'a=1,a=2', 'a[1]=1,a[1]=2').
If a hyperparameter name in both an index assignment and scalar assignment,
a ValueError is raised. (e.g. 'a=[1,2,3],a[0] = 1').
The hyperparameter name may contain '.' symbols, which will result in an
attribute name that is only accessible through the getattr and setattr
functions. (And must be first explicit added through add_hparam.)
The value in name=value must follows the syntax according to the
type of the parameter:
Scalar integer: A Python-parsable integer point value. E.g.: 1,
100, -12.
Scalar float: A Python-parsable floating point value. E.g.: 1.0,
-.54e89.
Boolean: Either true or false.
Scalar string: A non-empty sequence of characters, excluding comma,
spaces, and square brackets. E.g.: foo, bar_1.
List: A comma separated list of scalar values of the parameter type
enclosed in square brackets. E.g.: [1,2,3], [1.0,1e-12], [high,low].
When index assignment is used, the corresponding type_map key should be the
list name. E.g. for "arr[1]=0" the type_map must have the key "arr" (not
"arr[1]").
Args
values
String. Comma separated list of name=value pairs where
'value' must follow the syntax described above.
type_map
A dictionary mapping hyperparameter names to types. Note every
parameter name in values must be a key in type_map. The values must
conform to the types indicated, where a value V is said to conform to a
type T if either V has type T, or V is a list of elements of type T.
Hence, for a multidimensional parameter 'x' taking float values,
'x=[0.1,0.2]' will parse successfully if type_map['x'] = float.
ignore_unknown
Bool. Whether values that are missing a type in type_map
should be ignored. If set to True, a ValueError will not be raised for
unknown hyperparameter type.
Returns
A python map mapping each name to either:
A scalar value.
A list of scalar values.
A dictionary mapping index numbers to scalar values.
(e.g. "x=5,L=[1,2],arr[1]=3" results in {'x':5,'L':[1,2],'arr':{1:3} }")
Raises
ValueError
If there is a problem with input.
If values cannot be parsed.
If a list is assigned to a list index (e.g. 'a[1] = [1,2,3]').
If the same rvalue is assigned two different values (e.g. 'a=1,a=2',
'a[1]=1,a[1]=2', or 'a=1,a=[1]')
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.contrib.training.parse_values\n\n\u003cbr /\u003e\n\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/training/python/training/hparam.py#L195-L307) |\n\nParses hyperparameter values from a string into a python map. \n\n tf.contrib.training.parse_values(\n values, type_map, ignore_unknown=False\n )\n\n`values` is a string containing comma-separated `name=value` pairs.\nFor each pair, the value of the hyperparameter named `name` is set to\n`value`.\n\nIf a hyperparameter name appears multiple times in `values`, a ValueError\nis raised (e.g. 'a=1,a=2', 'a\\[1\\]=1,a\\[1\\]=2').\n\nIf a hyperparameter name in both an index assignment and scalar assignment,\na ValueError is raised. (e.g. 'a=\\[1,2,3\\],a\\[0\\] = 1').\n\nThe hyperparameter name may contain '.' symbols, which will result in an\nattribute name that is only accessible through the getattr and setattr\nfunctions. (And must be first explicit added through add_hparam.)\n| **Warning:** Use of '.' in your variable names is allowed, but is not well supported and not recommended.\n\nThe `value` in `name=value` must follows the syntax according to the\ntype of the parameter:\n\n- Scalar integer: A Python-parsable integer point value. E.g.: 1, 100, -12.\n- Scalar float: A Python-parsable floating point value. E.g.: 1.0, -.54e89.\n- Boolean: Either true or false.\n- Scalar string: A non-empty sequence of characters, excluding comma, spaces, and square brackets. E.g.: foo, bar_1.\n- List: A comma separated list of scalar values of the parameter type enclosed in square brackets. E.g.: \\[1,2,3\\], \\[1.0,1e-12\\], \\[high,low\\].\n\nWhen index assignment is used, the corresponding type_map key should be the\nlist name. E.g. for \"arr\\[1\\]=0\" the type_map must have the key \"arr\" (not\n\"arr\\[1\\]\").\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `values` | String. Comma separated list of `name=value` pairs where 'value' must follow the syntax described above. |\n| `type_map` | A dictionary mapping hyperparameter names to types. Note every parameter name in values must be a key in type_map. The values must conform to the types indicated, where a value V is said to conform to a type T if either V has type T, or V is a list of elements of type T. Hence, for a multidimensional parameter 'x' taking float values, 'x=\\[0.1,0.2\\]' will parse successfully if type_map\\['x'\\] = float. |\n| `ignore_unknown` | Bool. Whether values that are missing a type in type_map should be ignored. If set to True, a ValueError will not be raised for unknown hyperparameter type. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A python map mapping each name to either: \u003cbr /\u003e - A scalar value. - A list of scalar values. - A dictionary mapping index numbers to scalar values. (e.g. \"x=5,L=\\[1,2\\],arr\\[1\\]=3\" results in {'x':5,'L':\\[1,2\\],'arr':{1:3} }\") ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ValueError` | If there is a problem with input. \u003cbr /\u003e - If `values` cannot be parsed. - If a list is assigned to a list index (e.g. 'a\\[1\\] = \\[1,2,3\\]'). - If the same rvalue is assigned two different values (e.g. 'a=1,a=2', 'a\\[1\\]=1,a\\[1\\]=2', or 'a=1,a=\\[1\\]') |"]]
View source on GitHub