Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
regadas committed Feb 5, 2020
1 parent ba062c5 commit 7e81b82
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Simple CLI tool to read `TensorFlow` `TFRecords`.
## Install

### MacOs

```bash
brew tap spotify/public
brew install tfreader
Expand All @@ -16,7 +17,7 @@ Right now we only have binaries available under [releases](https://github.com/sp

## Usage

```
```bash
tfr
Usage: tfr [options] <files? | STDIN>
--usage <bool>
Expand All @@ -29,12 +30,28 @@ Usage: tfr [options] <files? | STDIN>
Number of records to output
```

### Example
## Examples

#### Google Cloud Storage

```bash
tfr -n 1 gs://<bucket>/<path>/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": {
Expand Down

0 comments on commit 7e81b82

Please sign in to comment.