ai.djl.repository

Class Resource

java.lang.Object

ai.djl.repository.Resource

public class Resource
extends java.lang.Object

A class represents a resource in a Repository.

Constructor Summary

Constructors

Constructor and Description
Resource(Repository repository, MRL mrl, java.lang.String version) Constructs a Resource instance.

Method Summary

Modifier and Type	Method and Description
Artifact	getDefaultArtifact() Returns the default artifact.
MRL	getMrl() Returns the MRL of the resource.
Repository	getRepository() Returns the Repository of the resource.
java.lang.String	getVersion() Returns the version of the resource.
java.util.List<Artifact>	listArtifacts() Returns a list of artifacts in this resource.
Artifact	match(java.util.Map<java.lang.String,java.lang.String> criteria) Returns the first artifact that matches a given criteria.
void	prepare(Artifact artifact) Prepares the artifact for use.
void	prepare(Artifact artifact, ai.djl.util.Progress progress) Prepares the artifact for use with progress tracking.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Resource

public Resource(Repository repository,
                MRL mrl,
                java.lang.String version)

Constructs a Resource instance.

Parameters:

repository - the Repository

mrl - the resource locator

version - the version of the resource

Method Detail

getRepository

public Repository getRepository()

Returns the Repository of the resource.

Returns:

the Repository of the resource

getMrl

public MRL getMrl()

Returns the MRL of the resource.

Returns:

the MRL of the resource

getVersion

public java.lang.String getVersion()

Returns the version of the resource.

Returns:

the version of the resource

getDefaultArtifact

public Artifact getDefaultArtifact()
                            throws java.io.IOException

Returns the default artifact.

Returns:

the default artifact

Throws:

java.io.IOException - for various exceptions depending on the specific dataset

match

public Artifact match(java.util.Map<java.lang.String,java.lang.String> criteria)
               throws java.io.IOException

Returns the first artifact that matches a given criteria.

Parameters:

criteria - the criteria to match against

Returns:

the first artifact that matches the criteria. Null will be returned if no artifact matches

Throws:

java.io.IOException - for errors while loading the model

listArtifacts

public java.util.List<Artifact> listArtifacts()
                                       throws java.io.IOException

Returns a list of artifacts in this resource.

Returns:

a list of artifacts in this resource

Throws:

java.io.IOException - for errors while loading the model

prepare

public void prepare(Artifact artifact)
             throws java.io.IOException

Prepares the artifact for use.

Parameters:

artifact - the artifact to prepare

Throws:

java.io.IOException - if it failed to prepare

prepare

public void prepare(Artifact artifact,
                    ai.djl.util.Progress progress)
             throws java.io.IOException

Prepares the artifact for use with progress tracking.

Parameters:

artifact - the artifact to prepare

progress - the progress tracker

Throws:

java.io.IOException - if it failed to prepare