vwdll.h File Reference

#include "stdint.h"
#include "stddef.h"
#include "vwvis.h"

Macros
#define	VW_CALLING_CONV
#define	VW_TYPE_SAFE_NULL   NULL

Typedefs
typedef void *	VW_HANDLE
typedef void *	VW_EXAMPLE
typedef void *	VW_LABEL
typedef void *	VW_FEATURE_SPACE
typedef void *	VW_FEATURE
typedef void *	VW_IOBUF

Functions
VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV	VW_InitializeA (const char *pstrArgs)
VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV	VW_InitializeEscapedA (const char *pstrArgs)
VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV	VW_InitializeWithModel (const char *pstrArgs, const char *modelData, size_t modelDataSize)
VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV	VW_InitializeWithModelEscaped (const char *pstrArgs, const char *modelData, size_t modelDataSize)
VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV	VW_SeedWithModel (VW_HANDLE handle, const char *extraArgs)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_Finish_Passes (VW_HANDLE handle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_Finish (VW_HANDLE handle)
VW_DLL_PUBLIC VW_EXAMPLE VW_CALLING_CONV	VW_ImportExample (VW_HANDLE handle, const char *label, VW_FEATURE_SPACE features, size_t len)
VW_DLL_PUBLIC VW_FEATURE_SPACE VW_CALLING_CONV	VW_InitializeFeatureSpaces (size_t len)
VW_DLL_PUBLIC VW_FEATURE_SPACE VW_CALLING_CONV	VW_GetFeatureSpace (VW_FEATURE_SPACE first, size_t index)
VW_DLL_PUBLIC VW_FEATURE_SPACE VW_CALLING_CONV	VW_ExportExample (VW_HANDLE handle, VW_EXAMPLE e, size_t *plen)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_ReleaseFeatureSpace (VW_FEATURE_SPACE features, size_t len)
VW_DLL_PUBLIC VW_EXAMPLE VW_CALLING_CONV	VW_ReadExampleA (VW_HANDLE handle, const char *line)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_StartParser (VW_HANDLE handle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_EndParser (VW_HANDLE handle)
VW_DLL_PUBLIC VW_EXAMPLE VW_CALLING_CONV	VW_GetExample (VW_HANDLE handle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_FinishExample (VW_HANDLE handle, VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetLabel (VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetImportance (VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetInitial (VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetPrediction (VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetCostSensitivePrediction (VW_EXAMPLE e)
VW_DLL_PUBLIC void *VW_CALLING_CONV	VW_GetMultilabelPredictions (VW_EXAMPLE e, size_t *plen)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetTopicPrediction (VW_EXAMPLE e, size_t i)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetActionScore (VW_EXAMPLE e, size_t i)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_GetActionScoreLength (VW_EXAMPLE e)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_GetTagLength (VW_EXAMPLE e)
VW_DLL_PUBLIC const char *VW_CALLING_CONV	VW_GetTag (VW_EXAMPLE e)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_GetFeatureNumber (VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_GetConfidence (VW_EXAMPLE e)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_SetFeatureSpace (VW_HANDLE handle, VW_FEATURE_SPACE feature_space, const char *name)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_InitFeatures (VW_FEATURE_SPACE feature_space, size_t features_count)
VW_DLL_PUBLIC VW_FEATURE VW_CALLING_CONV	VW_GetFeature (VW_FEATURE_SPACE feature_space, size_t index)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_SetFeature (VW_FEATURE feature, size_t index, size_t feature_hash, float value)
VW_DLL_PUBLIC VW_FEATURE VW_CALLING_CONV	VW_GetFeatures (VW_HANDLE handle, VW_EXAMPLE e, size_t *plen)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_ReturnFeatures (VW_FEATURE f)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_HashSpaceA (VW_HANDLE handle, const char *s)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_HashSpaceStaticA (const char *s, const char *h)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_HashFeatureA (VW_HANDLE handle, const char *s, size_t u)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_HashFeatureStaticA (const char *s, size_t u, const char *h, unsigned int num_bits)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_Learn (VW_HANDLE handle, VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_Predict (VW_HANDLE handle, VW_EXAMPLE e)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_PredictCostSensitive (VW_HANDLE handle, VW_EXAMPLE e)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_AddLabel (VW_EXAMPLE e, float label, float weight, float base)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_AddStringLabel (VW_HANDLE handle, VW_EXAMPLE e, const char *label)
VW_DLL_PUBLIC float VW_CALLING_CONV	VW_Get_Weight (VW_HANDLE handle, size_t index, size_t offset)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_Set_Weight (VW_HANDLE handle, size_t index, size_t offset, float value)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_Num_Weights (VW_HANDLE handle)
VW_DLL_PUBLIC size_t VW_CALLING_CONV	VW_Get_Stride (VW_HANDLE handle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_SaveModel (VW_HANDLE handle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_CopyModelData (VW_HANDLE handle, VW_IOBUF *bufferHandle, char **outputData, size_t *outputSize)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_FreeIOBuf (VW_IOBUF bufferHandle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_CaptureAuditData (VW_HANDLE handle)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_ClearCapturedAuditData (VW_HANDLE handle)
VW_DLL_PUBLIC char *VW_CALLING_CONV	VW_GetAuditDataA (VW_HANDLE handle, size_t *size)
VW_DLL_PUBLIC void VW_CALLING_CONV	VW_FreeAuditDataA (VW_HANDLE handle, char *data)

Variables
const VW_HANDLE	INVALID_VW_HANDLE = VW_TYPE_SAFE_NULL
const VW_HANDLE	INVALID_VW_EXAMPLE = VW_TYPE_SAFE_NULL

Macro Definition Documentation

VW_CALLING_CONV

#define VW_CALLING_CONV

VW_TYPE_SAFE_NULL

#define VW_TYPE_SAFE_NULL   NULL

Typedef Documentation

VW_EXAMPLE

typedef void* VW_EXAMPLE

VW_FEATURE

typedef void* VW_FEATURE

VW_FEATURE_SPACE

typedef void* VW_FEATURE_SPACE

VW_HANDLE

typedef void* VW_HANDLE

VW_IOBUF

typedef void* VW_IOBUF

VW_LABEL

typedef void* VW_LABEL

Function Documentation

VW_AddLabel()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_AddLabel	(	VW_EXAMPLE	e,
		float	label,
		float	weight,
		float	base
	)

VW_AddStringLabel()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_AddStringLabel	(	VW_HANDLE	handle,
		VW_EXAMPLE	e,
		const char *	label
	)

VW_CaptureAuditData()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_CaptureAuditData

(

VW_HANDLE

handle

)

VW_ClearCapturedAuditData()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_ClearCapturedAuditData

(

VW_HANDLE

handle

)

VW_CopyModelData()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_CopyModelData	(	VW_HANDLE	handle,
		VW_IOBUF *	bufferHandle,
		char **	outputData,
		size_t *	outputSize
	)

VW_EndParser()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_EndParser

(

VW_HANDLE

handle

)

VW_ExportExample()

VW_DLL_PUBLIC VW_FEATURE_SPACE VW_CALLING_CONV VW_ExportExample	(	VW_HANDLE	handle,
		VW_EXAMPLE	e,
		size_t *	plen
	)

VW_Finish()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_Finish

(

VW_HANDLE

handle

)

VW_Finish_Passes()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_Finish_Passes

(

VW_HANDLE

handle

)

VW_FinishExample()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_FinishExample	(	VW_HANDLE	handle,
		VW_EXAMPLE	e
	)

VW_FreeAuditDataA()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_FreeAuditDataA	(	VW_HANDLE	handle,
		char *	data
	)

VW_FreeIOBuf()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_FreeIOBuf

(

VW_IOBUF

bufferHandle

)

VW_Get_Stride()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_Get_Stride

(

VW_HANDLE

handle

)

VW_Get_Weight()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_Get_Weight	(	VW_HANDLE	handle,
		size_t	index,
		size_t	offset
	)

VW_GetActionScore()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetActionScore	(	VW_EXAMPLE	e,
		size_t	i
	)

VW_GetActionScoreLength()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_GetActionScoreLength

(

VW_EXAMPLE

e

)

VW_GetAuditDataA()

VW_DLL_PUBLIC char* VW_CALLING_CONV VW_GetAuditDataA	(	VW_HANDLE	handle,
		size_t *	size
	)

VW_GetConfidence()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetConfidence

(

VW_EXAMPLE

e

)

VW_GetCostSensitivePrediction()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetCostSensitivePrediction

(

VW_EXAMPLE

e

)

VW_GetExample()

VW_DLL_PUBLIC VW_EXAMPLE VW_CALLING_CONV VW_GetExample

(

VW_HANDLE

handle

)

VW_GetFeature()

VW_DLL_PUBLIC VW_FEATURE VW_CALLING_CONV VW_GetFeature	(	VW_FEATURE_SPACE	feature_space,
		size_t	index
	)

VW_GetFeatureNumber()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_GetFeatureNumber

(

VW_EXAMPLE

e

)

VW_GetFeatures()

VW_DLL_PUBLIC VW_FEATURE VW_CALLING_CONV VW_GetFeatures	(	VW_HANDLE	handle,
		VW_EXAMPLE	e,
		size_t *	plen
	)

VW_GetFeatureSpace()

VW_DLL_PUBLIC VW_FEATURE_SPACE VW_CALLING_CONV VW_GetFeatureSpace	(	VW_FEATURE_SPACE	first,
		size_t	index
	)

VW_GetImportance()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetImportance

(

VW_EXAMPLE

e

)

VW_GetInitial()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetInitial

(

VW_EXAMPLE

e

)

VW_GetLabel()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetLabel

(

VW_EXAMPLE

e

)

VW_GetMultilabelPredictions()

VW_DLL_PUBLIC void* VW_CALLING_CONV VW_GetMultilabelPredictions	(	VW_EXAMPLE	e,
		size_t *	plen
	)

VW_GetPrediction()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetPrediction

(

VW_EXAMPLE

e

)

VW_GetTag()

VW_DLL_PUBLIC const char* VW_CALLING_CONV VW_GetTag

(

VW_EXAMPLE

e

)

VW_GetTagLength()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_GetTagLength

(

VW_EXAMPLE

e

)

VW_GetTopicPrediction()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_GetTopicPrediction	(	VW_EXAMPLE	e,
		size_t	i
	)

VW_HashFeatureA()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_HashFeatureA	(	VW_HANDLE	handle,
		const char *	s,
		size_t	u
	)

VW_HashFeatureStaticA()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_HashFeatureStaticA	(	const char *	s,
		size_t	u,
		const char *	h,
		unsigned int	num_bits
	)

VW_HashSpaceA()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_HashSpaceA	(	VW_HANDLE	handle,
		const char *	s
	)

VW_HashSpaceStaticA()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_HashSpaceStaticA	(	const char *	s,
		const char *	h
	)

VW_ImportExample()

VW_DLL_PUBLIC VW_EXAMPLE VW_CALLING_CONV VW_ImportExample	(	VW_HANDLE	handle,
		const char *	label,
		VW_FEATURE_SPACE	features,
		size_t	len
	)

VW_InitFeatures()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_InitFeatures	(	VW_FEATURE_SPACE	feature_space,
		size_t	features_count
	)

VW_InitializeA()

VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV VW_InitializeA

(

const char *

pstrArgs

)

VW_InitializeEscapedA()

VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV VW_InitializeEscapedA

(

const char *

pstrArgs

)

VW_InitializeFeatureSpaces()

VW_DLL_PUBLIC VW_FEATURE_SPACE VW_CALLING_CONV VW_InitializeFeatureSpaces

(

size_t

len

)

VW_InitializeWithModel()

VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV VW_InitializeWithModel	(	const char *	pstrArgs,
		const char *	modelData,
		size_t	modelDataSize
	)

VW_InitializeWithModelEscaped()

VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV VW_InitializeWithModelEscaped	(	const char *	pstrArgs,
		const char *	modelData,
		size_t	modelDataSize
	)

VW_Learn()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_Learn	(	VW_HANDLE	handle,
		VW_EXAMPLE	e
	)

VW_Num_Weights()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_Num_Weights

(

VW_HANDLE

handle

)

VW_Predict()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_Predict	(	VW_HANDLE	handle,
		VW_EXAMPLE	e
	)

VW_PredictCostSensitive()

VW_DLL_PUBLIC float VW_CALLING_CONV VW_PredictCostSensitive	(	VW_HANDLE	handle,
		VW_EXAMPLE	e
	)

VW_ReadExampleA()

VW_DLL_PUBLIC VW_EXAMPLE VW_CALLING_CONV VW_ReadExampleA	(	VW_HANDLE	handle,
		const char *	line
	)

VW_ReleaseFeatureSpace()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_ReleaseFeatureSpace	(	VW_FEATURE_SPACE	features,
		size_t	len
	)

VW_ReturnFeatures()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_ReturnFeatures

(

VW_FEATURE

f

)

VW_SaveModel()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_SaveModel

(

VW_HANDLE

handle

)

VW_SeedWithModel()

VW_DLL_PUBLIC VW_HANDLE VW_CALLING_CONV VW_SeedWithModel	(	VW_HANDLE	handle,
		const char *	extraArgs
	)

VW_Set_Weight()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_Set_Weight	(	VW_HANDLE	handle,
		size_t	index,
		size_t	offset,
		float	value
	)

VW_SetFeature()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_SetFeature	(	VW_FEATURE	feature,
		size_t	index,
		size_t	feature_hash,
		float	value
	)

VW_SetFeatureSpace()

VW_DLL_PUBLIC size_t VW_CALLING_CONV VW_SetFeatureSpace	(	VW_HANDLE	handle,
		VW_FEATURE_SPACE	feature_space,
		const char *	name
	)

VW_StartParser()

VW_DLL_PUBLIC void VW_CALLING_CONV VW_StartParser

(

VW_HANDLE

handle

)

Variable Documentation

INVALID_VW_EXAMPLE

const VW_HANDLE INVALID_VW_EXAMPLE = VW_TYPE_SAFE_NULL

INVALID_VW_HANDLE

const VW_HANDLE INVALID_VW_HANDLE = VW_TYPE_SAFE_NULL