Package rawDeepLearningClassifier.defaultModels

Interface DLModel

All Known Implementing Classes:
HumpbackWhaleAtlantic, HumpbackWhaleGoogle, MultiSpeciesGoogle, RightWhaleModel1
public interface DLModel
A default model that can be loaded from a file or a URL.

  • Method Details

    • getDescription

      String getDescription()
      Get a brief description of the model.
      Returns:
      a brief description of the model.

    • getName

      String getName()
      Get a name for the model
      Returns:

    • getCitation

      String getCitation()
      Get the citation for the model
      Returns:
      - the citation.

    • getModelURI

      URI getModelURI()
      Get the URI to the model file
      Returns:
      the model URI.

    • getModelName

      String getModelName()
      The model name. This is used if, for example, a model is downloaded as a zip file and the model file is located somewhere within the saved folder. For Tensorflow models this will often be saved_model.pb
      Returns:
      the model name;

    • getCitationLink

      URI getCitationLink()
      Get the link to the paper for the model
      Returns:
      the citation link.

    • setParams

      void setParams(Serializable dlModelSettings)
      Set the model settings once it has loaded.
      Parameters:
      dlModelSettings - - the model settings.