From 5dc6b3ac244a72445f65f1772f15b6e6092c393e Mon Sep 17 00:00:00 2001 From: fynnbe Date: Fri, 26 Apr 2024 15:46:49 +0200 Subject: [PATCH] update README.md --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7908c2db..f22fa44f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # core-bioimage-io-python -Python specific core utilities for [bioimage.io]("https://bioimage.io") resources (in particular models). +Python specific core utilities for bioimage.io resources (in particular models). ## Installation @@ -69,7 +69,7 @@ pip install -e . --no-deps There are different environment files available that only install tensorflow or pytorch as dependencies. -## 💻 Command Line +## 💻 Use the Command Line Interface `bioimageio.core` installs a command line interface (CLI) for testing models and other functionality. You can list all the available commands via: @@ -104,7 +104,7 @@ bioimagei predict-images -m -i - o `` is a `glob` pattern to select the desired images, e.g. `/path/to/my/images/*.tif`. -## 🐍 From python +## 🐍 Use in Python `bioimageio.core` is a python package that implements prediction with bioimageio models including standardized pre- and postprocessing operations. @@ -116,6 +116,8 @@ To get an overview of this functionality, check out these example notebooks: * [model creation/loading with bioimageio.spec](https://github.com/bioimage-io/spec-bioimage-io/blob/main/example_use/load_model_and_create_your_own.ipynb) +and the [developer documentation](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html). + ## Model Specification The model specification and its validation tools can be found at .