Skip to content

Commit 35192ab

Browse files
committed
Make docs clearer
1 parent 91b9f26 commit 35192ab

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/1_quickstart/creating.md renamed to docs/1_quickstart/importing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Importing metadata
22

33
It might not be convenient to maintain a huge `model-index.yml` file in your repository. So `model-index` make it easy
4-
to stitch together metadata from many different sources.
4+
to split data into smaller file.
55

66
Data can be imported from other YAML files, JSON files and from Markdown files.
77

@@ -45,7 +45,8 @@ and `inception_v3_results.json` could look like this:
4545

4646
## Importing a whole YAML file
4747

48-
Import in your `model-index.yml`:
48+
You can split the model index into smaller files (e.g. containing a single collection of related models)
49+
and then import them into the main `model-index.yml` file:
4950

5051
```yaml
5152
Import:

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ to have your library featured on the website.
1616
1_quickstart/installation.md
1717
1_quickstart/howitworks.md
1818
1_quickstart/examples.md
19-
1_quickstart/creating.md
19+
1_quickstart/importing.md
2020
1_quickstart/checking.md
2121
1_quickstart/upload.md
2222
```

0 commit comments

Comments
 (0)