Package ai.djl.repository

Class SimpleRepository

java.lang.Object

ai.djl.repository.AbstractRepository

ai.djl.repository.SimpleRepository

All Implemented Interfaces:

Repository

public class SimpleRepository
extends AbstractRepository

A SimpleRepository is a Repository containing only a single artifact without requiring a "metadata.json" file.

See Also:

Repository

Field Summary

Fields inherited from class ai.djl.repository.AbstractRepository

arguments, name, uri

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleRepository(java.lang.String name, java.net.URI uri, java.nio.file.Path path)	(Internal) Constructs a SimpleRepository.

Method Summary

Modifier and Type	Method	Description
protected void	download(java.nio.file.Path tmp, java.net.URI baseUri, Artifact.Item item, ai.djl.util.Progress progress)
java.net.URI	getBaseUri()	Returns the URI to the base of the repository.
java.nio.file.Path	getCacheDirectory()	Returns the cache directory for the repository.
java.nio.file.Path	getResourceDirectory(Artifact artifact)	Returns the resource directory for the an artifact.
java.util.List<MRL>	getResources()	Returns a list of MRLs in the repository.
boolean	isRemote()	Returns whether the repository is remote repository.
Metadata	locate(MRL mrl)	Returns the metadata at a mrl.
void	prepare(Artifact artifact, ai.djl.util.Progress progress)	Prepares the artifact for use with progress tracking.
Artifact	resolve(MRL mrl, java.util.Map<java.lang.String,java.lang.String> filter)	Returns the artifact matching a mrl, version, and property filter.
protected java.net.URI	resolvePath(Artifact.Item item, java.lang.String path)

Methods inherited from class ai.djl.repository.AbstractRepository

addResource, getFile, getName, listDirectory, openStream, save

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.repository.Repository

dataset, dataset, model, model, model, prepare

Constructor Detail

SimpleRepository

protected SimpleRepository(java.lang.String name,
                           java.net.URI uri,
                           java.nio.file.Path path)

(Internal) Constructs a SimpleRepository.

Use Repository.newInstance(String, String).

Parameters:

name - the name of the repository

uri - the base URI of the repository

path - the path to the repository

Method Detail

isRemote

public boolean isRemote()

Returns whether the repository is remote repository.

Returns:

whether the repository is remote repository

getBaseUri

public java.net.URI getBaseUri()

Returns the URI to the base of the repository.

Specified by:

getBaseUri in interface Repository

Overrides:

getBaseUri in class AbstractRepository

Returns:

the URI

locate

public Metadata locate(MRL mrl)
                throws java.io.IOException

Returns the metadata at a mrl.

Parameters:

mrl - the mrl of the metadata to retrieve

Returns:

the metadata

Throws:

java.io.IOException - if it failed to load the metadata

resolve

public Artifact resolve(MRL mrl,
                        java.util.Map<java.lang.String,java.lang.String> filter)
                 throws java.io.IOException

Returns the artifact matching a mrl, version, and property filter.

Parameters:

mrl - the mrl to match the artifact against

filter - the property filter

Returns:

the matched artifact

Throws:

java.io.IOException - if it failed to load the artifact

getResourceDirectory

public java.nio.file.Path getResourceDirectory(Artifact artifact)
                                        throws java.io.IOException

Returns the resource directory for the an artifact.

Parameters:

artifact - the artifact whose resource directory to return

Returns:

the resource directory path

Throws:

java.io.IOException - if it failed to ensure the creation of the cache directory

download

protected void download(java.nio.file.Path tmp,
                        java.net.URI baseUri,
                        Artifact.Item item,
                        ai.djl.util.Progress progress)
                 throws java.io.IOException

Overrides:

download in class AbstractRepository

Throws:

java.io.IOException

prepare

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

Prepares the artifact for use with progress tracking.

Specified by:

prepare in interface Repository

Overrides:

prepare in class AbstractRepository

Parameters:

artifact - the artifact to prepare

progress - the progress tracker

Throws:

java.io.IOException - if it failed to prepare

getCacheDirectory

public java.nio.file.Path getCacheDirectory()
                                     throws java.io.IOException

Returns the cache directory for the repository.

Specified by:

getCacheDirectory in interface Repository

Overrides:

getCacheDirectory in class AbstractRepository

Returns:

the cache directory path

Throws:

java.io.IOException - if it failed to ensure the creation of the cache directory

resolvePath

protected java.net.URI resolvePath(Artifact.Item item,
                                   java.lang.String path)
                            throws java.io.IOException

Overrides:

resolvePath in class AbstractRepository

Throws:

java.io.IOException

getResources

public java.util.List<MRL> getResources()

Returns a list of MRLs in the repository.

An empty list will be returned if underlying Repository implementation does not support this feature.

Returns:

a list of MRLs in the repository