Skip to content

Commit

Permalink
Improve community partner docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oeway authored Jun 7, 2023
1 parent 87d71df commit d1a30b6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/community_partners/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
BioImage.IO is a community-driven open source initiative, providing access to trained deep learning models and related resources contributed by the community members. To help us better disseminate and maintain the resources, we introduced the concepts of **community partner**.

## What is a community partner?
Usually, a community partner is an organization, a company, a research group, or a software team (of one or more) that can consume resources of the BioImage.Io model zoo. Additionally, most partners continuously and openly contribute resources of their own. The first community partners represent open source consumer software of BioImage.IO (e.g. ilastik, Fiji, deepImageJ, ZeroCostDL4Mic, StarDist).
Usually, a community partner is an organization, a company, a research group, or a software team (of one or more) that can consume and/or produce resources of the BioImage.Io model zoo. Additionally, most partners continuously and openly contribute resources of their own. The first community partners represent open source consumer software of BioImage.IO (e.g. ilastik, Fiji, deepImageJ, ZeroCostDL4Mic, StarDist).

### Benefits as a community partner
By joining BioImage.IO as a community partner, you will be able to:
Expand All @@ -17,7 +17,7 @@ By joining BioImage.IO as a community partner, you will be able to:
The main responsibilities of a community partner are:
- Use BioImage.IO as their only primary trained model repository.
- Review resources contributed by others that claim to be compatible with this community partner software.
- Maintain this community partner's models and other resources, and keep them up-to-date with the latest spec.
- Maintain this community partner's models and other resources in their linked repository, setup continous integration workflows to test models and keep them up-to-date with the latest spec.

### Who should join as a community partner?
* A team behind a software which produces or consumes trained models compatible with the BioImage.IO spec.
Expand All @@ -29,6 +29,10 @@ Community partners can host their own Github repository for storing models and o
![bioimage-io-community-partners](bioimage-io-community-partners.png)


## How to setup CI in the community partner repository
See more information here: https://github.com/bioimage-io/collection-bioimage-io#contribute-resource-test-summaries


## Report User Analytics

Community partners can use our user analytics service to report resource downloads and access to statistics.
Expand Down

0 comments on commit d1a30b6

Please sign in to comment.