Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewekhalel committed Nov 26, 2018
1 parent b95c0c8 commit ec8ff4c
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Expand Up @@ -60,7 +60,7 @@ Configuration file is a json file containing two pieces of information
* **GEO** : Geometric mean
3. Number of bits image (default is 8-bits) (**bits**).

Example of a conf file
Example of a conf file in `json` format
```json
{
"augs":["NO",
Expand All @@ -69,8 +69,15 @@ Example of a conf file
"mean":"ARITH",
"bits":8
}

```
Example of a conf file in `yaml` format
```yaml
augs: [NO,FLIP_UD,FLIP_LR]
mean: ARITH
bits: 8
```
You can either pass file path or the actual json text to `conf` parameter.
You can either pass file path (json or yaml) or the actual json text to `conf` parameter.

## Contribution
All contributions are welcomed. Please make sure that all tests passed before pull request. To run tests
Expand Down

0 comments on commit ec8ff4c

Please sign in to comment.