Skip to content

Commit e1dce5c

Browse files
authored
Merge pull request #446 from bioimage-io/update-readme
Update example links
2 parents ee87863 + 3e3da99 commit e1dce5c

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -358,20 +358,32 @@ These models are described by---and can be loaded with---the bioimageio.spec pac
358358

359359
In addition bioimageio.core provides functionality to convert model weight formats.
360360

361-
To get an overview of this functionality, check out these example notebooks:
361+
### Documentation
362+
[Here you find the bioimageio.core documentation.](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html)
363+
364+
#### Presentations
365+
- [Create a model from scratch](https://bioimage-io.github.io/core-bioimage-io-python/presentations/create_ambitious_sloth.slides.html) ([source](https://github.com/bioimage-io/core-bioimage-io-python/tree/main/presentations))
366+
367+
#### Examples
368+
<dl>
369+
<dt>Notebooks that save and load resource descriptions and validate their format (using <a href="https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/spec.html">bioimageio.spec</a>, a dependency of bioimageio.core)</dt>
370+
<dd><a href="https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb">load_model_and_create_your_own.ipynb</a> <a target="_blank" href="https://colab.research.google.com/github/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb">
371+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
372+
</a></dd>
373+
<dd><a href="https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/dataset_creation.ipynb">dataset_creation.ipynb</a> <a target="_blank" href="https://colab.research.google.com/github/bioimage-io/spec-bioimage-io/blob/main/example/dataset_creation.ipynb">
374+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
375+
</a></dd>
376+
<dt>Use the described resources in Python with <a href="https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html">bioimageio.core</a></dt>
377+
<dd><a href="https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb">model_usage.ipynb</a><a target="_blank" href="https://colab.research.google.com/github/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb">
378+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
379+
</dl>
362380

363-
- [model creation/loading with bioimageio.spec](https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb)
364-
365-
and the [developer documentation](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html).
366381

367382
## Logging level
368383

369384
`bioimageio.spec` and `bioimageio.core` use [loguru](https://github.com/Delgan/loguru) for logging, hence the logging level
370385
may be controlled with the `LOGURU_LEVEL` environment variable.
371386

372-
## Model Specification
373-
374-
The model specification and its validation tools can be found at <https://github.com/bioimage-io/spec-bioimage-io>.
375387

376388
## Changelog
377389

0 commit comments

Comments
 (0)