org.nd4j.versioncheck

Class VersionCheck

java.lang.Object

org.nd4j.versioncheck.VersionCheck

public class VersionCheck
extends Object

A runtime version check utility that does 2 things:
(a) validates the versions of ND4J, DL4J, DataVec, RL4J, Arbiter on the class path, logging a warning if incompatible versions are found
(b) allows users to get version information for the above projects at runtime.

Author:

Alex Black

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionCheck.Detail Detailed level for logging: GAV: display group ID, artifact, version GAVC: display group ID, artifact, version, commit ID FULL: display group ID, artifact, version, commit ID, build time, branch, commit message

Field Summary

Fields

Modifier and Type	Field and Description
static String	GIT_PROPERTY_FILE_SUFFIX
static String	PROPERTIES_FILE_SUFFIX
static String	VERSION_CHECK_PROPERTY Deprecated. Use ND4JSystemProperties.VERSION_CHECK_PROPERTY

Method Summary

Modifier and Type	Method and Description
static void	checkVersions() Perform a check of the versions of ND4J, DL4J, DataVec, RL4J and Arbiter dependencies, logging a warning if necessary.
static List<VersionInfo>	getVersionInfos()
static List<URI>	listGitPropertiesFiles()
static void	logVersionInfo() Log of the version information with the default level of detail
static void	logVersionInfo(VersionCheck.Detail detail) Log the version information with the specified level of detail
static String	versionInfoString()
static String	versionInfoString(VersionCheck.Detail detail) Get the version information for dependencies as a string with a specified amount of detail

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_CHECK_PROPERTY

@Deprecated
public static final String VERSION_CHECK_PROPERTY

Deprecated. Use ND4JSystemProperties.VERSION_CHECK_PROPERTY

See Also:

Constant Field Values

GIT_PROPERTY_FILE_SUFFIX

public static final String GIT_PROPERTY_FILE_SUFFIX

See Also:

Constant Field Values

PROPERTIES_FILE_SUFFIX

public static final String PROPERTIES_FILE_SUFFIX

See Also:

Constant Field Values

Method Detail

checkVersions

public static void checkVersions()

Perform a check of the versions of ND4J, DL4J, DataVec, RL4J and Arbiter dependencies, logging a warning if necessary.

listGitPropertiesFiles

public static List<URI> listGitPropertiesFiles()

Returns:

A list of the property files containing the build/version info

getVersionInfos

public static List<VersionInfo> getVersionInfos()

Returns:

A list containing the information for the discovered dependencies

versionInfoString

public static String versionInfoString()

Returns:

A string representation of the version information, with the default (GAV) detail level

versionInfoString

public static String versionInfoString(VersionCheck.Detail detail)

Get the version information for dependencies as a string with a specified amount of detail

Parameters:

detail - Detail level for the version information. See VersionCheck.Detail

Returns:

Version information, as a String

logVersionInfo

public static void logVersionInfo()

Log of the version information with the default level of detail

logVersionInfo

public static void logVersionInfo(VersionCheck.Detail detail)

Log the version information with the specified level of detail

Parameters:

detail - Level of detail for logging