Skip to content

Commit

Permalink
update proto version and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jameswex committed Feb 18, 2023
1 parent 83c7d9f commit 98cc994
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 1,154 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Interesting values (such as a high proportion of missing data, or very different
Features can be sorted by values of interest such as the number of missing values or the skew between the different datasets.

The python code to generate the statistics for visualization can be installed through `pip install facets-overview`.
As of version 1.1.0, the `facets-overview` package requires a version of `protobuf` at version 3.20.0 or later.

Details about Overview usage can be found in its [README](./facets_overview/README.md).

Expand Down
1 change: 1 addition & 0 deletions facets_overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ The feature statistics protocol buffer can be created for datasets by the python
This code can be installed through `pip install facets-overview`. TensorFlow should also be installed but is not included as a
pip dependency, so as to allow a user to depend on either the tensorflow or tensorflow-gpu package as necessary.
Datasets can be analyzed either from a TfRecord files of tensorflow Example protocol buffers, or from pandas DataFrames.
As of version 1.1.0, the `facets-overview` package requires a version of `protobuf` at version 3.20.0 or later.

To create the proto from a pandas DataFrame, use the `ProtoFromDataFrames` method of the [GenericFeatureStatisticsGenerator class](./python/generic_feature_statistics_generator.py).
To create the proto from a TfRecord file, use the `ProtoFromTfRecordFiles` method of the [FeatureStatisticsGenerator class](./python/feature_statistics_generator.py).
Expand Down
Loading

0 comments on commit 98cc994

Please sign in to comment.