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 Asset asset, @NonNull String experimentKey) Extracts query parameters from the provided Asset.
static RemoteAsset	createRemoteAsset(@NonNull URI uri, Optional<String> fileName, boolean overwrite, Optional<Map<String,Object>> metadata) Creates remote asset representation encapsulated into RemoteAsset instance.
static Stream<Asset>	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<Asset> 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 Asset objects.

Throws:

IOException - if an I/O exception occurred.

createRemoteAsset

public static RemoteAsset createRemoteAsset(@NonNull
                                            @NonNull URI uri,
                                            Optional<String> fileName,
                                            boolean overwrite,
                                            Optional<Map<String,Object>> metadata)

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.

fileName - 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.

Returns:

the initialized RemoteAsset instance.

assetQueryParameters

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

Extracts query parameters from the provided Asset.

Parameters:

asset - the Asset to extract HTTP query parameters from.

experimentKey - the Experiment key.

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.