com.logicalclocks.hsfs

Class FeatureViewBase<T extends FeatureViewBase,T3 extends FeatureStoreBase<T4>,T4 extends QueryBase,T5>

java.lang.Object

com.logicalclocks.hsfs.FeatureViewBase<T,T3,T4,T5>

Direct Known Subclasses:

FeatureView, FeatureView

public abstract class FeatureViewBase<T extends FeatureViewBase,T3 extends FeatureStoreBase<T4>,T4 extends QueryBase,T5>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected Integer	extraFilterVersion
protected List<TrainingDatasetFeature>	features
protected T3	featureStore
protected Integer	id
protected List<String>	labels
protected static org.slf4j.Logger	LOGGER
protected String	name
protected T4	query
protected String	type
protected VectorServer	vectorServer
protected Integer	version

Constructor Summary

Constructors

Constructor and Description
FeatureViewBase()

Method Summary

Modifier and Type	Method and Description
abstract void	addTag(String name, Object value) Add name/value tag to the feature view.
abstract void	addTrainingDatasetTag(Integer version, String name, Object value) Add name/value tag to the training dataset.
abstract void	clean(T3 featureStore, String featureViewName, Integer featureViewVersion)
abstract void	delete()
abstract void	deleteAllTrainingDatasets()
abstract void	deleteTag(String name) Delete a tag of the feature view.
abstract void	deleteTrainingDataset(Integer version)
abstract void	deleteTrainingDatasetTag(Integer version, String name) Delete a tag of the training dataset.
abstract T5	getBatchData()
abstract T5	getBatchData(String startTime, String endTime)
abstract T5	getBatchData(String startTime, String endTime, Map<String,String> readOptions)
abstract String	getBatchQuery()
abstract String	getBatchQuery(String startTime, String endTime)
List<Object>	getFeatureVector(Map<String,Object> entry) Returns assembled feature vector from online feature store.
List<Object>	getFeatureVector(Map<String,Object> entry, boolean external) Returns assembled feature vector from online feature store.
List<List<Object>>	getFeatureVectors(Map<String,List<Object>> entry) Returns assembled feature vectors in batches from online feature store.
List<List<Object>>	getFeatureVectors(Map<String,List<Object>> entry, boolean external) Returns assembled feature vectors in batches from online feature store.
HashSet<String>	getPrimaryKeys() Set of primary key names that is used as keys in input dict object for `get_serving_vector` method.
abstract Object	getTag(String name) Get a single tag value of the feature view.
abstract Map<String,Object>	getTags() Get all tags of the feature view.
abstract Object	getTrainingData(Integer version, Map<String,String> readOptions)
abstract Object	getTrainingDatasetTag(Integer version, String name) Get a single tag value of the training dataset.
abstract Map<String,Object>	getTrainingDatasetTags(Integer version) Get all tags of the training dataset.
abstract Object	getTrainTestSplit(Integer version, Map<String,String> readOptions)
abstract Object	getTrainValidationTestSplit(Integer version, Map<String,String> readOptions)
void	initBatchScoring(Integer trainingDatasetVersion) Initialise feature view to retrieve feature vector from offline feature store.
void	initServing() Initialise feature view to retrieve feature vector from online feature store.
void	initServing(Boolean batch, Boolean external) Deprecated.
abstract void	purgeAllTrainingData()
abstract void	purgeTrainingData(Integer version)
abstract T	update(T other)
protected void	validateTrainTestSplit(Float testSize, String trainEnd, String testStart)
protected void	validateTrainValidationTestSplit(Float validationSize, Float testSize, String trainEnd, String validationStart, String validationEnd, String testStart)

Methods inherited from class java.lang.Object

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

Field Detail

featureStore

protected T3 extends FeatureStoreBase<T4> featureStore

id

protected Integer id

name

protected String name

version

protected Integer version

description

protected String description

features

protected List<TrainingDatasetFeature> features

query

protected T4 extends QueryBase query

labels

protected List<String> labels

type

protected String type

LOGGER

protected static final org.slf4j.Logger LOGGER

vectorServer

protected VectorServer vectorServer

extraFilterVersion

protected Integer extraFilterVersion

Constructor Detail

FeatureViewBase

public FeatureViewBase()

Method Detail

initServing

public void initServing()
                 throws FeatureStoreException,
                        IOException,
                        SQLException,
                        ClassNotFoundException

Initialise feature view to retrieve feature vector from online feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // Initialise feature view serving
        fv.initServing();
 
 

Throws:

FeatureStoreException - In case client is not connected to Hopsworks.

IOException - Generic IO exception.

SQLException - In case there is online storage (RonDB) access error or other errors.

ClassNotFoundException - In case class `com.mysql.jdbc.Driver` can not be found.

initServing

@Deprecated
public void initServing(Boolean batch,
                                    Boolean external)
                             throws FeatureStoreException,
                                    IOException,
                                    SQLException,
                                    ClassNotFoundException

Deprecated.

Initialise feature view to retrieve feature vector from online feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // Initialise feature view batch serving
        fv.initServing(true, false);
 
 

Parameters:

batch - Whether to initialise feature view to retrieve feature vector from offline feature store.

external - If set to `true`, the connection to the online feature store is established using the same host as for the `host` parameter in the connection object. If set to False, the online feature store storage connector is used which relies on the private IP.

Throws:

FeatureStoreException - In case client is not connected to Hopsworks.

IOException - Generic IO exception.

SQLException - In case there is online storage (RonDB) access error or other errors.

ClassNotFoundException - In case class `com.mysql.jdbc.Driver` can not be found.

validateTrainTestSplit

protected void validateTrainTestSplit(Float testSize,
                                      String trainEnd,
                                      String testStart)
                               throws FeatureStoreException

Throws:

FeatureStoreException

validateTrainValidationTestSplit

protected void validateTrainValidationTestSplit(Float validationSize,
                                                Float testSize,
                                                String trainEnd,
                                                String validationStart,
                                                String validationEnd,
                                                String testStart)
                                         throws FeatureStoreException

Throws:

FeatureStoreException

initBatchScoring

public void initBatchScoring(Integer trainingDatasetVersion)

Initialise feature view to retrieve feature vector from offline feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // Initialise feature view batch scoring
        fv.initBatchScoring(1);
 
 

Parameters:

trainingDatasetVersion - Version of training dataset to identify additional filters attached to the training dataset and statistics to use for transformation functions.

getFeatureVector

public List<Object> getFeatureVector(Map<String,Object> entry)
                              throws SQLException,
                                     FeatureStoreException,
                                     IOException,
                                     ClassNotFoundException

Returns assembled feature vector from online feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // define primary key values to fetch data from online feature store
        Map<String, Object> pkMap = new HashMap<String, Object>() {
               {put("customer_id", 1);
                put("contract_id" , 100);
                }
        };
        // get feature vector
        fv.getFeatureVector(entry);
 
 

Parameters:

entry - Fictionary of feature group primary key and values provided by serving application.

Returns:

List of feature values related to provided primary keys, ordered according to positions of the features in the feature view query.

Throws:

FeatureStoreException - In case client is not connected to Hopsworks.

IOException - Generic IO exception.

SQLException - In case there is online storage (RonDB) access error or other errors.

ClassNotFoundException - In case class `com.mysql.jdbc.Driver` can not be found.

getFeatureVector

public List<Object> getFeatureVector(Map<String,Object> entry,
                                     boolean external)
                              throws SQLException,
                                     FeatureStoreException,
                                     IOException,
                                     ClassNotFoundException

Returns assembled feature vector from online feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // define primary key values to fetch data from online feature store
        Map<String, Object> pkMap = new HashMap<String, Object>() {
               {put("customer_id", 1);
                put("contract_id" , 100);
                }
        };
        // get feature vector
        fv.getFeatureVector(entry, false);
 
 

Parameters:

entry - Dictionary of feature group primary key and values provided by serving application.

external - If set to true, the connection to the online feature store is established using the same host as for the `host` parameter in the connection object. If set to false, the online feature store storage connector is used which relies on the private IP. Defaults to True if connection to Hopsworks is established from external environment

Returns:

List of feature values related to provided primary keys, ordered according to positions of the features in the feature view query.

Throws:

FeatureStoreException - In case client is not connected to Hopsworks.

IOException - Generic IO exception.

SQLException - In case there is online storage (RonDB) access error or other errors.

ClassNotFoundException - In case class `com.mysql.jdbc.Driver` can not be found.

getFeatureVectors

public List<List<Object>> getFeatureVectors(Map<String,List<Object>> entry)
                                     throws SQLException,
                                            FeatureStoreException,
                                            IOException,
                                            ClassNotFoundException

Returns assembled feature vectors in batches from online feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // define primary key values to fetch data from online feature store
        Map<String, List<Long>> entry = ...;
        // get feature vector
        fv.getFeatureVector(entry);
 
 

Parameters:

entry - A list of dictionaries of feature group primary key and values provided by serving application.

Returns:

List of lists of feature values related to provided primary keys, ordered according to positions of the features in the feature view query.

Throws:

FeatureStoreException - In case client is not connected to Hopsworks.

IOException - Generic IO exception.

SQLException - In case there is online storage (RonDB) access error or other errors.

ClassNotFoundException - In case class `com.mysql.jdbc.Driver` can not be found.

getFeatureVectors

public List<List<Object>> getFeatureVectors(Map<String,List<Object>> entry,
                                            boolean external)
                                     throws SQLException,
                                            FeatureStoreException,
                                            IOException,
                                            ClassNotFoundException

Returns assembled feature vectors in batches from online feature store.

 
        // get feature store handle
        FeatureStore fs = HopsworksConnection.builder().build().getFeatureStore();
        // get feature view handle
        FeatureView fv = fs.getFeatureView("fv_name", 1);
        // define primary key values to fetch data from online feature store
        Map<String, List<Long>> entry = ...;
        // get feature vector
        fv.getFeatureVectors(entry, false);
 
 

Parameters:

entry - A list of dictionaries of feature group primary key and values provided by serving application.

external - If set to `true`, the connection to the online feature store is established using the same host as for the `host` parameter in the connection object. If set to False, the online feature store storage connector is used which relies on the private IP.

Returns:

List of lists of feature values related to provided primary keys, ordered according to positions of this features in the feature view query.

Throws:

FeatureStoreException - In case client is not connected to Hopsworks.

IOException - Generic IO exception.

SQLException - In case there is online storage (RonDB) access error or other errors.

ClassNotFoundException - In case class `com.mysql.jdbc.Driver` can not be found.

addTag

public abstract void addTag(String name,
                            Object value)
                     throws FeatureStoreException,
                            IOException

Add name/value tag to the feature view.

Parameters:

name - name of the tag

value - value of the tag. The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException

IOException

getTags

public abstract Map<String,Object> getTags()
                                    throws FeatureStoreException,
                                           IOException

Get all tags of the feature view.

Returns:

a map of tag name and values. The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException

IOException

getTag

public abstract Object getTag(String name)
                       throws FeatureStoreException,
                              IOException

Get a single tag value of the feature view.

Parameters:

name - name of the tag

Returns:

The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException

IOException

deleteTag

public abstract void deleteTag(String name)
                        throws FeatureStoreException,
                               IOException

Delete a tag of the feature view.

Parameters:

name - name of the tag to be deleted

Throws:

FeatureStoreException

IOException

addTrainingDatasetTag

public abstract void addTrainingDatasetTag(Integer version,
                                           String name,
                                           Object value)
                                    throws FeatureStoreException,
                                           IOException

Add name/value tag to the training dataset.

Parameters:

name - name of the tag

value - value of the tag. The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException

IOException

getTrainingDatasetTags

public abstract Map<String,Object> getTrainingDatasetTags(Integer version)
                                                   throws FeatureStoreException,
                                                          IOException

Get all tags of the training dataset.

Returns:

a map of tag name and values. The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException

IOException

getTrainingDatasetTag

public abstract Object getTrainingDatasetTag(Integer version,
                                             String name)
                                      throws FeatureStoreException,
                                             IOException

Get a single tag value of the training dataset.

Parameters:

name - name of the tag

Returns:

The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException

IOException

deleteTrainingDatasetTag

public abstract void deleteTrainingDatasetTag(Integer version,
                                              String name)
                                       throws FeatureStoreException,
                                              IOException

Delete a tag of the training dataset.

Parameters:

name - name of the tag to be deleted

Throws:

FeatureStoreException

IOException

getPrimaryKeys

public HashSet<String> getPrimaryKeys()
                               throws SQLException,
                                      IOException,
                                      FeatureStoreException,
                                      ClassNotFoundException

Set of primary key names that is used as keys in input dict object for `get_serving_vector` method.

Returns:

Set of serving keys

Throws:

SQLException

IOException

FeatureStoreException

ClassNotFoundException

delete

public abstract void delete()
                     throws FeatureStoreException,
                            IOException

Throws:

FeatureStoreException

IOException

clean

public abstract void clean(T3 featureStore,
                           String featureViewName,
                           Integer featureViewVersion)
                    throws FeatureStoreException,
                           IOException

Throws:

FeatureStoreException

IOException

update

public abstract T update(T other)
                  throws FeatureStoreException,
                         IOException

Throws:

FeatureStoreException

IOException

getBatchQuery

public abstract String getBatchQuery()
                              throws FeatureStoreException,
                                     IOException,
                                     ParseException

Throws:

FeatureStoreException

IOException

ParseException

getBatchQuery

public abstract String getBatchQuery(String startTime,
                                     String endTime)
                              throws FeatureStoreException,
                                     IOException,
                                     ParseException

Throws:

FeatureStoreException

IOException

ParseException

getBatchData

public abstract T5 getBatchData()
                         throws FeatureStoreException,
                                IOException,
                                ParseException

Throws:

FeatureStoreException

IOException

ParseException

getBatchData

public abstract T5 getBatchData(String startTime,
                                String endTime)
                         throws FeatureStoreException,
                                IOException,
                                ParseException

Throws:

FeatureStoreException

IOException

ParseException

getBatchData

public abstract T5 getBatchData(String startTime,
                                String endTime,
                                Map<String,String> readOptions)
                         throws FeatureStoreException,
                                IOException,
                                ParseException

Throws:

FeatureStoreException

IOException

ParseException

getTrainingData

public abstract Object getTrainingData(Integer version,
                                       Map<String,String> readOptions)
                                throws IOException,
                                       FeatureStoreException,
                                       ParseException

Throws:

IOException

FeatureStoreException

ParseException

getTrainTestSplit

public abstract Object getTrainTestSplit(Integer version,
                                         Map<String,String> readOptions)
                                  throws IOException,
                                         FeatureStoreException,
                                         ParseException

Throws:

IOException

FeatureStoreException

ParseException

getTrainValidationTestSplit

public abstract Object getTrainValidationTestSplit(Integer version,
                                                   Map<String,String> readOptions)
                                            throws IOException,
                                                   FeatureStoreException,
                                                   ParseException

Throws:

IOException

FeatureStoreException

ParseException

purgeTrainingData

public abstract void purgeTrainingData(Integer version)
                                throws FeatureStoreException,
                                       IOException

Throws:

FeatureStoreException

IOException

purgeAllTrainingData

public abstract void purgeAllTrainingData()
                                   throws FeatureStoreException,
                                          IOException

Throws:

FeatureStoreException

IOException

deleteTrainingDataset

public abstract void deleteTrainingDataset(Integer version)
                                    throws FeatureStoreException,
                                           IOException

Throws:

FeatureStoreException

IOException

deleteAllTrainingDatasets

public abstract void deleteAllTrainingDatasets()
                                        throws FeatureStoreException,
                                               IOException

Throws:

FeatureStoreException

IOException