tfx icon indicating copy to clipboard operation
tfx copied to clipboard

Add *.proto files to tfx python wheel package

Open robertlugg opened this issue 6 years ago • 3 comments

Understanding the output of protoc is difficult. Those files reference source. For instance:

# -*- coding: utf-8 -*-
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: tfx/proto/example_gen.proto

, yet I don't see those files in this project.

Reading the *.proto files is a lot easier than the *_pb2.py files. Would you consider adding those files? Or at least reference another location where they can be examined?

robertlugg avatar Aug 02 '19 20:08 robertlugg

The problem is that they do exist in this project: https://github.com/tensorflow/tfx/tree/master/tfx/proto , but aren't included after the python installation (ie after python setup.py install). I guess it's reasonable to not have them in the install.

robertlugg avatar Aug 02 '19 21:08 robertlugg

We can use 'package_data' to include the protos. It's worth to include them for debugging purpose, IMO.

zhitaoli avatar Aug 05 '19 17:08 zhitaoli

If there is a clean way to supply them, I think library users would benefit from having them in the install. I'll reopen for visibility but I totally understand if you don't feel a change is warranted.

robertlugg avatar Aug 05 '19 18:08 robertlugg