tfx icon indicating copy to clipboard operation
tfx copied to clipboard

What is example_gen_pb2 and where is it documented?

Open oonisim opened this issue 2 years ago • 1 comments

URL(s) with the issue:

https://www.tensorflow.org/tfx/guide/examplegen

Please provide a link to the documentation entry, for example: https://www.tensorflow.org/tfx/guide/examplegen

Description of issue (what needs changing):

The ExampleGen TFX Pipeline Component has the example code which uses example_gen_pb2 but cannot find out the documentation which explains it and how to use it. Please provide the URL of the API documentation of example_gen_pb2.

# Input has a single split 'input_dir/*'.
# Output 2 splits: train:eval=3:1.
output = proto.Output(
             split_config=example_gen_pb2.SplitConfig(splits=[
                 proto.SplitConfig.Split(name='train', hash_buckets=3),
                 proto.SplitConfig.Split(name='eval', hash_buckets=1)
             ]))
example_gen = CsvExampleGen(input_base=input_dir, output_config=output)

oonisim avatar Apr 26 '22 07:04 oonisim

The API doc is here

but since it's proto file, the easiest way is checking the definition itself, which has comments for the data structure

1025KB avatar May 06 '22 00:05 1025KB

As mentioned above, since its a protofile, you can look at the definition to understand it and so its not added in docs. Closing this issue as its expected. Thanks!!

gowthamkpr avatar Sep 28 '22 18:09 gowthamkpr