From 7e81b82fefc0c2f50cc108c3416ad77dc9e7a0ef Mon Sep 17 00:00:00 2001 From: Filipe Regadas Date: Wed, 5 Feb 2020 13:38:00 -0500 Subject: [PATCH] Update README --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 30f18a2..e7381f9 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ Simple CLI tool to read `TensorFlow` `TFRecords`. ## Install ### MacOs + ```bash brew tap spotify/public brew install tfreader @@ -16,7 +17,7 @@ Right now we only have binaries available under [releases](https://github.com/sp ## Usage -``` +```bash tfr Usage: tfr [options] --usage @@ -29,12 +30,28 @@ Usage: tfr [options] Number of records to output ``` -### Example +## Examples + +#### Google Cloud Storage + +```bash +tfr -n 1 gs:////part-00000-of-00004.tfrecords | jq . +``` + +#### Local Filesystem ```bash tfr -n 1 core/src/test/resources/part-00000-of-00004.tfrecords | jq . ``` +#### `stdin` + +```bash +cat core/src/test/resources/part-00000-of-00004.tfrecords | tfr -n 1 | jq . +``` + +### Output Example + ```json { "features": {