tfds.dataset_builders.ViewConfig
Stay organized with collections
Save and categorize content based on your preferences.
Builder config for a view transforming another dataset.
Inherits From: BuilderConfig
tfds.dataset_builders.ViewConfig(
*,
name: str,
input_dataset=None,
ex_transformations=None,
ds_transformations=None,
**kwargs
)
Arguments |
name
|
the name of this config.
|
input_dataset
|
the dataset on which this view is being applied. If None ,
the input dataset needs to be specified in the ViewBuilder .
|
ex_transformations
|
transformations that need to be applied to individual
examples / rows. The transformations are normal Python functions. See
the documentation for more information. Note that you cannot specify
both example and dataset transformations.
|
ds_transformations
|
tf.data transformations that are applied on the
whole tf.data.Dataset . Note that you cannot specify both example and
dataset transformations.
|
**kwargs
|
additional arguments passed to the BuilderConfig such as
version , release_notes , supported_versions , and description .
|
Attributes |
name
|
Dataclass field
|
version
|
Dataclass field
|
release_notes
|
Dataclass field
|
supported_versions
|
Dataclass field
|
description
|
Dataclass field
|
tags
|
Dataclass field
|
Methods
from_dataset_info
View source
@classmethod
from_dataset_info(
info_proto: dataset_info_pb2.DatasetInfo
) -> Optional['BuilderConfig']
Instantiates a BuilderConfig from the given proto.
Args |
info_proto
|
DatasetInfo proto which documents the requested dataset
config, including its name, version, and features.
|
Returns |
A BuilderConfig for the requested config.
|
View source
input_dataset_builder(
data_dir: Optional[str] = None
) -> dataset_builder.DatasetBuilder
Class Variables |
description
|
None
|
release_notes
|
None
|
version
|
None
|
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-04-26 UTC.
[null,null,["Last updated 2024-04-26 UTC."],[],[],null,["# tfds.dataset_builders.ViewConfig\n\n\u003cbr /\u003e\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/datasets/blob/v4.9.3/tensorflow_datasets/core/dataset_builders/view_builder.py#L45-L95) |\n\nBuilder config for a view transforming another dataset.\n\nInherits From: [`BuilderConfig`](../../tfds/core/BuilderConfig) \n\n tfds.dataset_builders.ViewConfig(\n *,\n name: str,\n input_dataset=None,\n ex_transformations=None,\n ds_transformations=None,\n **kwargs\n )\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Arguments --------- ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | the name of this config. |\n| `input_dataset` | the dataset on which this view is being applied. If `None`, the input dataset needs to be specified in the `ViewBuilder`. |\n| `ex_transformations` | transformations that need to be applied to individual examples / rows. The transformations are normal Python functions. See the documentation for more information. Note that you cannot specify both example and dataset transformations. |\n| `ds_transformations` | [`tf.data`](https://www.tensorflow.org/api_docs/python/tf/data) transformations that are applied on the whole [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset). Note that you cannot specify both example and dataset transformations. |\n| `**kwargs` | additional arguments passed to the `BuilderConfig` such as `version`, `release_notes`, `supported_versions`, and `description`. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Attributes ---------- ||\n|----------------------|-----------------|\n| `name` | Dataclass field |\n| `version` | Dataclass field |\n| `release_notes` | Dataclass field |\n| `supported_versions` | Dataclass field |\n| `description` | Dataclass field |\n| `tags` | Dataclass field |\n\n\u003cbr /\u003e\n\nMethods\n-------\n\n### `from_dataset_info`\n\n[View source](https://github.com/tensorflow/datasets/blob/v4.9.3/tensorflow_datasets/core/dataset_builder.py#L113-L135) \n\n @classmethod\n from_dataset_info(\n info_proto: dataset_info_pb2.DatasetInfo\n ) -\u003e Optional['BuilderConfig']\n\nInstantiates a BuilderConfig from the given proto.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|--------------|------------------------------------------------------------------------------------------------------------|\n| `info_proto` | DatasetInfo proto which documents the requested dataset config, including its name, version, and features. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|---|---|\n| A BuilderConfig for the requested config. ||\n\n\u003cbr /\u003e\n\n### `input_dataset_builder`\n\n[View source](https://github.com/tensorflow/datasets/blob/v4.9.3/tensorflow_datasets/core/dataset_builders/view_builder.py#L88-L95) \n\n input_dataset_builder(\n data_dir: Optional[str] = None\n ) -\u003e dataset_builder.DatasetBuilder\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Class Variables --------------- ||\n|---------------|--------|\n| description | `None` |\n| release_notes | `None` |\n| version | `None` |\n\n\u003cbr /\u003e"]]