java.lang.Object
qupath.bioimageio.spec.Resource
General resource, based upon the RDF.
For machine learning models, you probably want Model.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfile and other attachmentsThe authors are the creators of the model RDF and the primary points of contact.Get the badges for the resource.getCite()Get the citations for the resource.Cover images.Get the resource descriptionURL or relative path to a markdown file with additional documentation.Get the version of the bioimage format used for this resource.Get a link to the git repository for this resourcegetIcon()Get the relative path to the resource icongetID()bioimage.io-wide unique resource identifier assigned by bioimage.io; version **un**specific.getLinks()IDs of other bioimage.io resourcesMaintainers of this resource.getName()A human-readable name of this model.Get the source file for the resourcegetTags()Associated tageGet the version of the resource.booleanisFormatNewerThan(String version) Compare a resource's format version to a semantic version
-
Constructor Details
-
Resource
public Resource()
-
-
Method Details
-
getVersion
Get the version of the resource.- Returns:
- A semantic version hopefully, or maybe just an int, or worse, something else...
-
getBadges
Get the badges for the resource.- Returns:
- The badges
-
getCite
Get the citations for the resource.- Returns:
- the cite entries.
-
getDocumentation
URL or relative path to a markdown file with additional documentation. The recommended documentation file name is `README.md`. An `.md` suffix is mandatory. The documentation should include a '[#[#]]# Validation' (sub)section with details on how to quantitatively validate the model on unseen data.- Returns:
- A URL or path.
-
getName
A human-readable name of this model. It should be no longer than 64 characters and only contain letter, number, underscore, minus or space characters."""- Returns:
- the name
-
getIcon
Get the relative path to the resource icon- Returns:
- the path to the icon.
-
getGitRepo
Get a link to the git repository for this resource- Returns:
- Hopefully a git:// or http(s):// link, but I guess it could be a file://...
-
getDescription
Get the resource description- Returns:
- A string of unknown length or content.
-
getFormatVersion
Get the version of the bioimage format used for this resource. There were big changes between 0.4.x and 0.5.x that should mostly be handled by this library internally, but some behaviour may be inconsistent.- Returns:
- The format as a (hopefully SemVer) string.
-
getLicense
A SPDX license identifier. We do not support custom license beyond the SPDX license list.- Returns:
- the license
-
getSource
Get the source file for the resource- Returns:
- a file path or http(s) link potentially
-
getID
bioimage.io-wide unique resource identifier assigned by bioimage.io; version **un**specific.- Returns:
- the ID
-
getAuthors
The authors are the creators of the model RDF and the primary points of contact.- Returns:
- The authors.
-
getMaintainers
Maintainers of this resource. If not specified `authors` are maintainers and at least some of them should specify their `github_user` name- Returns:
- The maintainers
-
getLinks
IDs of other bioimage.io resources- Returns:
- links
-
getTags
Associated tage- Returns:
- the tags
-
getCovers
Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.- Returns:
- links to image files
-
getAttachments
file and other attachments- Returns:
- attachments
-
isFormatNewerThan
Compare a resource's format version to a semantic version- Parameters:
version- The semantic version we're comparing to- Returns:
- Whether the resource's version is newer than this.
-