ml.comet.experiment.impl.utils

Class AssetUtils

java.lang.Object

ml.comet.experiment.impl.utils.AssetUtils

public class AssetUtils
extends Object

Utilities to work with assets.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REMOTE_FILE_NAME_DEFAULT

Constructor Summary

Constructors

Constructor and Description
AssetUtils()

Method Summary

Modifier and Type	Method and Description
static Map<FormParamName,Object>	assetFormParameters(@NonNull Asset asset) Extracts form parameters from the provided Asset.
static Map<QueryParamName,String>	assetQueryParameters(@NonNull AssetImpl asset, @NonNull String experimentKey) Extracts query parameters from the provided Asset.
static AssetImpl	createAssetFromData(byte[] data, @NonNull String logicalPath, boolean overwrite, @NonNull Optional<Map<String,Object>> metadata, @NonNull Optional<String> type) Creates the Asset from the file-like data.
static AssetImpl	createAssetFromFile(@NonNull File file, Optional<String> logicalPath, boolean overwrite, @NonNull Optional<Map<String,Object>> metadata, @NonNull Optional<String> type) Creates the Asset from the local file.
static RemoteAssetImpl	createRemoteAsset(@NonNull URI uri, Optional<String> logicalPath, boolean overwrite, Optional<Map<String,Object>> metadata, Optional<String> type) Creates remote asset representation encapsulated into RemoteAsset instance.
static AssetType	toAssetType(@NonNull String typeName) Allows converting type name to the AssetType.
static AssetImpl	updateAsset(AssetImpl asset, boolean overwrite, Optional<Map<String,Object>> metadata, Optional<String> type) Updates provided AssetImpl with values from optionals or with defaults.
static Stream<AssetImpl>	walkFolderAssets(@NonNull File folder, boolean logFilePath, boolean recursive, boolean prefixWithFolderName) Walks through the asset files in the given folder and produce stream of Asset objects holding information about file assets found in the folder.

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_FILE_NAME_DEFAULT

public static final String REMOTE_FILE_NAME_DEFAULT

See Also:

Constant Field Values

Constructor Detail

AssetUtils

public AssetUtils()

Method Detail

walkFolderAssets

public static Stream<AssetImpl> walkFolderAssets(@NonNull
                                                 @NonNull File folder,
                                                 boolean logFilePath,
                                                 boolean recursive,
                                                 boolean prefixWithFolderName)
                                          throws IOException

Walks through the asset files in the given folder and produce stream of Asset objects holding information about file assets found in the folder.

Parameters:

folder - the folder where to look for asset files

logFilePath - if true the file path relative to the folder will be used. Otherwise, basename of the asset file will be used.

recursive - if true then subfolder files will be included recursively.

prefixWithFolderName - if true then path of each asset file will be prefixed with folder name in case if logFilePath is true.

Returns:

the stream of AssetImpl objects.

Throws:

IOException - if an I/O exception occurred.

createRemoteAsset

public static RemoteAssetImpl createRemoteAsset(@NonNull
                                                @NonNull URI uri,
                                                Optional<String> logicalPath,
                                                boolean overwrite,
                                                Optional<Map<String,Object>> metadata,
                                                Optional<String> type)

Creates remote asset representation encapsulated into RemoteAsset instance.

Parameters:

uri - the URI pointing to the remote asset location. There is no imposed format, and it could be a private link.

logicalPath - the optional "name" of the remote asset, could be a dataset name, a model file name.

overwrite - if true will overwrite all existing assets with the same name.

metadata - Some additional data to attach to the remote asset. The dictionary values must be JSON compatible.

type - the type of the asset. If not specified the default type AssetType.ASSET will be assigned.

Returns:

the initialized RemoteAssetImpl instance.

createAssetFromFile

public static AssetImpl createAssetFromFile(@NonNull
                                            @NonNull File file,
                                            Optional<String> logicalPath,
                                            boolean overwrite,
                                            @NonNull
                                            @NonNull Optional<Map<String,Object>> metadata,
                                            @NonNull
                                            @NonNull Optional<String> type)

Creates the Asset from the local file.

Parameters:

file - the asset file.

logicalPath - the logical name for the asset file.

overwrite - if true mark as override

metadata - the metadata to associate with asset. The dictionary values must be JSON compatible.

type - the type of the asset. If not specified the default type AssetType.ASSET will be assigned.

Returns:

the instance of the AssetImpl from the local file.

createAssetFromData

public static AssetImpl createAssetFromData(byte[] data,
                                            @NonNull
                                            @NonNull String logicalPath,
                                            boolean overwrite,
                                            @NonNull
                                            @NonNull Optional<Map<String,Object>> metadata,
                                            @NonNull
                                            @NonNull Optional<String> type)

Creates the Asset from the file-like data.

Parameters:

data - the asset's data.

logicalPath - the logical name for the asset file.

overwrite - if true mark as override

metadata - the metadata to associate with asset. The dictionary values must be JSON compatible.

type - the type of the asset. If not specified the default type AssetType.ASSET_TYPE_ASSET will be assigned.

Returns:

the instance of the AssetImpl from the file-like data.

assetQueryParameters

public static Map<QueryParamName,String> assetQueryParameters(@NonNull
                                                              @NonNull AssetImpl asset,
                                                              @NonNull
                                                              @NonNull String experimentKey)

Extracts query parameters from the provided Asset.

Parameters:

asset - the AssetImpl to extract HTTP query parameters from.

experimentKey - the key of the Comet experiment.

Returns:

the map with query parameters.

assetFormParameters

public static Map<FormParamName,Object> assetFormParameters(@NonNull
                                                            @NonNull Asset asset)

Extracts form parameters from the provided Asset.

Parameters:

asset - the Asset to extract HTTP form parameters from.

Returns:

the map with form parameters.

updateAsset

public static AssetImpl updateAsset(AssetImpl asset,
                                    boolean overwrite,
                                    Optional<Map<String,Object>> metadata,
                                    Optional<String> type)

Updates provided AssetImpl with values from optionals or with defaults.

Parameters:

asset - the AssetImpl to be updated.

overwrite - if true will overwrite all existing assets with the same name.

metadata - Some additional data to attach to the remote asset. The dictionary values must be JSON compatible.

type - the type of the asset. If not specified the default type AssetType.ASSET_TYPE_ASSET will be assigned.

Returns:

the updated AssetImpl with values from optionals or with defaults.

toAssetType

public static AssetType toAssetType(@NonNull
                                    @NonNull String typeName)

Allows converting type name to the AssetType.

Parameters:

typeName - the type name.

Returns:

the appropriate AssetType enum value or UNKNOWN value if failed.