java.lang.Object
qupath.bioimageio.spec.Resource
Direct Known Subclasses:
Dataset, Model

public class Resource extends Object
General resource, based upon the RDF.

For machine learning models, you probably want Model.

  • Constructor Details

    • Resource

      public Resource()
  • Method Details

    • getVersion

      public String getVersion()
      Get the version of the resource.
      Returns:
      A semantic version hopefully, or maybe just an int, or worse, something else...
    • getBadges

      public List<Badge> getBadges()
      Get the badges for the resource.
      Returns:
      The badges
    • getCite

      public List<CiteEntry> getCite()
      Get the citations for the resource.
      Returns:
      the cite entries.
    • getDocumentation

      public String 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

      public String 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

      public String getIcon()
      Get the relative path to the resource icon
      Returns:
      the path to the icon.
    • getGitRepo

      public String 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

      public String getDescription()
      Get the resource description
      Returns:
      A string of unknown length or content.
    • getFormatVersion

      public String 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

      public String getLicense()
      A SPDX license identifier. We do not support custom license beyond the SPDX license list.
      Returns:
      the license
    • getSource

      public String getSource()
      Get the source file for the resource
      Returns:
      a file path or http(s) link potentially
    • getID

      public String getID()
      bioimage.io-wide unique resource identifier assigned by bioimage.io; version **un**specific.
      Returns:
      the ID
    • getAuthors

      public List<Author> getAuthors()
      The authors are the creators of the model RDF and the primary points of contact.
      Returns:
      The authors.
    • getMaintainers

      public List<Author> 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

      public List<String> getLinks()
      IDs of other bioimage.io resources
      Returns:
      links
    • getTags

      public List<String> getTags()
      Associated tage
      Returns:
      the tags
    • getCovers

      public List<String> 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

      public Map<String,?> getAttachments()
      file and other attachments
      Returns:
      attachments
    • isFormatNewerThan

      public boolean isFormatNewerThan(String version)
      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.