com.logicalclocks.hsfs.beam

Class FeatureView

java.lang.Object

com.logicalclocks.hsfs.FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

com.logicalclocks.hsfs.beam.FeatureView

public class FeatureView
extends FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Field Summary

Fields inherited from class com.logicalclocks.hsfs.FeatureViewBase

description, extraFilterVersion, features, featureStore, id, labels, LOGGER, name, query, type, vectorServer, version

Constructor Summary

Constructors

Constructor and Description
FeatureView()

Method Summary

Modifier and Type	Method and Description
void	addTag(String name, Object value) Add name/value tag to the feature view.
void	addTrainingDatasetTag(Integer version, String name, Object value) Add name/value tag to the training dataset.
void	clean(FeatureStore featureStore, String featureViewName, Integer featureViewVersion)
void	delete()
void	deleteAllTrainingDatasets()
void	deleteTag(String name) Delete a tag of the feature view.
void	deleteTrainingDataset(Integer version)
void	deleteTrainingDatasetTag(Integer version, String name) Delete a tag of the training dataset.
org.apache.beam.sdk.values.PCollection<Object>	getBatchData()
org.apache.beam.sdk.values.PCollection<Object>	getBatchData(String startTime, String endTime)
org.apache.beam.sdk.values.PCollection<Object>	getBatchData(String startTime, String endTime, Map<String,String> readOptions)
String	getBatchQuery()
String	getBatchQuery(String startTime, String endTime)
Object	getTag(String name) Get a single tag value of the feature view.
Map<String,Object>	getTags() Get all tags of the feature view.
Object	getTrainingData(Integer version, Map<String,String> readOptions)
Object	getTrainingDatasetTag(Integer version, String name) Get a single tag value of the training dataset.
Map<String,Object>	getTrainingDatasetTags(Integer version) Get all tags of the training dataset.
Object	getTrainTestSplit(Integer version, Map<String,String> readOptions)
Object	getTrainValidationTestSplit(Integer version, Map<String,String> readOptions)
void	purgeAllTrainingData()
void	purgeTrainingData(Integer version)
FeatureView	update(FeatureView other)

Methods inherited from class com.logicalclocks.hsfs.FeatureViewBase

getFeatureVector, getFeatureVector, getFeatureVectors, getFeatureVectors, getPrimaryKeys, initBatchScoring, initServing, initServing, validateTrainTestSplit, validateTrainValidationTestSplit

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureView

public FeatureView()

Method Detail

addTag

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

Description copied from class: FeatureViewBase

Add name/value tag to the feature view.

Specified by:

addTag in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

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 Map<String,Object> getTags()
                           throws FeatureStoreException,
                                  IOException

Description copied from class: FeatureViewBase

Get all tags of the feature view.

Specified by:

getTags in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

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 Object getTag(String name)
              throws FeatureStoreException,
                     IOException

Description copied from class: FeatureViewBase

Get a single tag value of the feature view.

Specified by:

getTag in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

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 void deleteTag(String name)
               throws FeatureStoreException,
                      IOException

Description copied from class: FeatureViewBase

Delete a tag of the feature view.

Specified by:

deleteTag in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Parameters:

name - name of the tag to be deleted

Throws:

FeatureStoreException

IOException

addTrainingDatasetTag

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

Description copied from class: FeatureViewBase

Add name/value tag to the training dataset.

Specified by:

addTrainingDatasetTag in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

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 Map<String,Object> getTrainingDatasetTags(Integer version)
                                          throws FeatureStoreException,
                                                 IOException

Description copied from class: FeatureViewBase

Get all tags of the training dataset.

Specified by:

getTrainingDatasetTags in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

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 Object getTrainingDatasetTag(Integer version,
                                    String name)
                             throws FeatureStoreException,
                                    IOException

Description copied from class: FeatureViewBase

Get a single tag value of the training dataset.

Specified by:

getTrainingDatasetTag in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

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 void deleteTrainingDatasetTag(Integer version,
                                     String name)
                              throws FeatureStoreException,
                                     IOException

Description copied from class: FeatureViewBase

Delete a tag of the training dataset.

Specified by:

deleteTrainingDatasetTag in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

name - name of the tag to be deleted

Throws:

FeatureStoreException

IOException

delete

public void delete()
            throws FeatureStoreException,
                   IOException

Specified by:

delete in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

clean

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

Specified by:

clean in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

update

public FeatureView update(FeatureView other)
                   throws FeatureStoreException,
                          IOException

Specified by:

update in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

getBatchQuery

public String getBatchQuery()
                     throws FeatureStoreException,
                            IOException,
                            ParseException

Specified by:

getBatchQuery in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

ParseException

getBatchQuery

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

Specified by:

getBatchQuery in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

ParseException

getBatchData

public org.apache.beam.sdk.values.PCollection<Object> getBatchData()
                                                            throws FeatureStoreException,
                                                                   IOException,
                                                                   ParseException

Specified by:

getBatchData in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

ParseException

getBatchData

public org.apache.beam.sdk.values.PCollection<Object> getBatchData(String startTime,
                                                                   String endTime)
                                                            throws FeatureStoreException,
                                                                   IOException,
                                                                   ParseException

Specified by:

getBatchData in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

ParseException

getBatchData

public org.apache.beam.sdk.values.PCollection<Object> getBatchData(String startTime,
                                                                   String endTime,
                                                                   Map<String,String> readOptions)
                                                            throws FeatureStoreException,
                                                                   IOException,
                                                                   ParseException

Specified by:

getBatchData in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

ParseException

getTrainingData

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

Specified by:

getTrainingData in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

IOException

FeatureStoreException

ParseException

getTrainTestSplit

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

Specified by:

getTrainTestSplit in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

IOException

FeatureStoreException

ParseException

getTrainValidationTestSplit

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

Specified by:

getTrainValidationTestSplit in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

IOException

FeatureStoreException

ParseException

purgeTrainingData

public void purgeTrainingData(Integer version)
                       throws FeatureStoreException,
                              IOException

Specified by:

purgeTrainingData in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

purgeAllTrainingData

public void purgeAllTrainingData()
                          throws FeatureStoreException,
                                 IOException

Specified by:

purgeAllTrainingData in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

deleteTrainingDataset

public void deleteTrainingDataset(Integer version)
                           throws FeatureStoreException,
                                  IOException

Specified by:

deleteTrainingDataset in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException

deleteAllTrainingDatasets

public void deleteAllTrainingDatasets()
                               throws FeatureStoreException,
                                      IOException

Specified by:

deleteAllTrainingDatasets in class FeatureViewBase<FeatureView,FeatureStore,com.logicalclocks.hsfs.beam.constructor.Query,org.apache.beam.sdk.values.PCollection<Object>>

Throws:

FeatureStoreException

IOException