org.deeplearning4j.common.resources

Class DL4JResources

java.lang.Object

org.deeplearning4j.common.resources.DL4JResources

public class DL4JResources
extends Object

DL4JResources controls the local storage locations for models and datasets that are downloaded and stored locally.
The storage location is customizable in 2 ways:
(a) via the DL4J_RESOURCES_DIR_PROPERTY system property, org.deeplearning4j.resources.directory
(b) By calling setBaseDirectory(File) at runtime

Author:

Alex Black

Field Summary

Fields

Modifier and Type	Field and Description
static String	DL4J_BASE_URL_PROPERTY Deprecated. Use DL4JSystemProperties.DL4J_RESOURCES_BASE_URL_PROPERTY
static String	DL4J_RESOURCES_DIR_PROPERTY Deprecated. Use DL4JSystemProperties.DL4J_RESOURCES_DIR_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DL4JResources()

Method Summary

Modifier and Type	Method and Description
static File	getBaseDirectory()
static String	getBaseDownloadURL()
static File	getDirectory(ResourceType resourceType, String resourceName) Get the storage location for the specified resource type and resource name
static URL	getURL(String relativeToBase) Get the URL relative to the base URL. For example, if baseURL is "http://blob.deeplearning4j.org/", and relativeToBase is "/datasets/iris.dat" this simply returns "http://blob.deeplearning4j.org/datasets/iris.dat"
static String	getURLString(String relativeToBase) Get the URL relative to the base URL as a String. For example, if baseURL is "http://blob.deeplearning4j.org/", and relativeToBase is "/datasets/iris.dat" this simply returns "http://blob.deeplearning4j.org/datasets/iris.dat"
static void	resetBaseDirectoryLocation() Reset to the default directory, or the directory set via the DL4JSystemProperties.DL4J_RESOURCES_DIR_PROPERTY system property, org.deeplearning4j.resources.directory
static void	setBaseDirectory(File f) Set the base directory for local storage of files.
static void	setBaseDownloadURL(String baseDownloadURL) Set the base download URL for (most) DL4J datasets and models. This usually doesn't need to be set manually unless there is some issue with the default location

Methods inherited from class java.lang.Object

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

Field Detail

DL4J_RESOURCES_DIR_PROPERTY

@Deprecated
public static final String DL4J_RESOURCES_DIR_PROPERTY

Deprecated. Use DL4JSystemProperties.DL4J_RESOURCES_DIR_PROPERTY

See Also:

Constant Field Values

DL4J_BASE_URL_PROPERTY

@Deprecated
public static final String DL4J_BASE_URL_PROPERTY

Deprecated. Use DL4JSystemProperties.DL4J_RESOURCES_BASE_URL_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DL4JResources

public DL4JResources()

Method Detail

setBaseDownloadURL

public static void setBaseDownloadURL(@NonNull
                                      String baseDownloadURL)

Set the base download URL for (most) DL4J datasets and models.
This usually doesn't need to be set manually unless there is some issue with the default location

Parameters:

baseDownloadURL - Base download URL to set. For example, http://blob.deeplearning4j.org/

getBaseDownloadURL

public static String getBaseDownloadURL()

Returns:

The base URL hosting DL4J datasets and models

getURL

public static URL getURL(String relativeToBase)
                  throws MalformedURLException

Get the URL relative to the base URL.
For example, if baseURL is "http://blob.deeplearning4j.org/", and relativeToBase is "/datasets/iris.dat" this simply returns "http://blob.deeplearning4j.org/datasets/iris.dat"

Parameters:

relativeToBase - Relative URL

Returns:

URL

Throws:

MalformedURLException - For bad URL

getURLString

public static String getURLString(String relativeToBase)

Get the URL relative to the base URL as a String.
For example, if baseURL is "http://blob.deeplearning4j.org/", and relativeToBase is "/datasets/iris.dat" this simply returns "http://blob.deeplearning4j.org/datasets/iris.dat"

Parameters:

relativeToBase - Relative URL

Returns:

URL

Throws:

MalformedURLException - For bad URL

resetBaseDirectoryLocation

public static void resetBaseDirectoryLocation()

Reset to the default directory, or the directory set via the DL4JSystemProperties.DL4J_RESOURCES_DIR_PROPERTY system property, org.deeplearning4j.resources.directory

setBaseDirectory

public static void setBaseDirectory(@NonNull
                                    File f)

Set the base directory for local storage of files. Default is: new File(System.getProperty("user.home"), ".deeplearning4j")

Parameters:

f - Base directory to use for resources

getBaseDirectory

public static File getBaseDirectory()

Returns:

The base storage directory for DL4J resources

getDirectory

public static File getDirectory(ResourceType resourceType,
                                String resourceName)

Get the storage location for the specified resource type and resource name

Parameters:

resourceType - Type of resource

resourceName - Name of the resource

Returns:

The root directory. Creates the directory and any parent directories, if required