ML::PCA::opg Namespace Reference

Functions
void	fit (raft::handle_t &handle, std::vector< MLCommon::Matrix::Data< float > * > &input_data, MLCommon::Matrix::PartDescriptor &input_desc, float *components, float *explained_var, float *explained_var_ratio, float *singular_vals, float *mu, float *noise_vars, paramsPCAMG prms, bool verbose=false)
	performs MNMG fit operation for the pca More...
void	fit (raft::handle_t &handle, std::vector< MLCommon::Matrix::Data< double > * > &input_data, MLCommon::Matrix::PartDescriptor &input_desc, double *components, double *explained_var, double *explained_var_ratio, double *singular_vals, double *mu, double *noise_vars, paramsPCAMG prms, bool verbose=false)
void	fit_transform (raft::handle_t &handle, MLCommon::Matrix::RankSizePair **rank_sizes, std::uint32_t n_parts, MLCommon::Matrix::floatData_t **input, MLCommon::Matrix::floatData_t **trans_input, float *components, float *explained_var, float *explained_var_ratio, float *singular_vals, float *mu, float *noise_vars, paramsPCAMG prms, bool verbose)
	performs MNMG fit and transform operation for the pca More...
void	fit_transform (raft::handle_t &handle, MLCommon::Matrix::RankSizePair **rank_sizes, std::uint32_t n_parts, MLCommon::Matrix::doubleData_t **input, MLCommon::Matrix::doubleData_t **trans_input, double *components, double *explained_var, double *explained_var_ratio, double *singular_vals, double *mu, double *noise_vars, paramsPCAMG prms, bool verbose)
void	transform (raft::handle_t &handle, MLCommon::Matrix::RankSizePair **rank_sizes, std::uint32_t n_parts, MLCommon::Matrix::Data< float > **input, float *components, MLCommon::Matrix::Data< float > **trans_input, float *singular_vals, float *mu, paramsPCAMG prms, bool verbose)
	performs MNMG transform operation for the pca More...
void	transform (raft::handle_t &handle, MLCommon::Matrix::RankSizePair **rank_sizes, std::uint32_t n_parts, MLCommon::Matrix::Data< double > **input, double *components, MLCommon::Matrix::Data< double > **trans_input, double *singular_vals, double *mu, paramsPCAMG prms, bool verbose)
void	inverse_transform (raft::handle_t &handle, MLCommon::Matrix::RankSizePair **rank_sizes, std::uint32_t n_parts, MLCommon::Matrix::Data< float > **trans_input, float *components, MLCommon::Matrix::Data< float > **input, float *singular_vals, float *mu, paramsPCAMG prms, bool verbose)
	performs MNMG inverse transform operation for the pca More...
void	inverse_transform (raft::handle_t &handle, MLCommon::Matrix::RankSizePair **rank_sizes, std::uint32_t n_parts, MLCommon::Matrix::Data< double > **trans_input, double *components, MLCommon::Matrix::Data< double > **input, double *singular_vals, double *mu, paramsPCAMG prms, bool verbose)
void	sign_flip (raft::handle_t &handle, std::vector< MLCommon::Matrix::Data< float > * > &input_data, MLCommon::Matrix::PartDescriptor &input_desc, float *components, std::size_t n_components, cudaStream_t *streams, std::uint32_t n_stream)
	sign flip for PCA and tSVD. This is used to stabilize the sign of column major eigen vectors More...
void	sign_flip (raft::handle_t &handle, std::vector< MLCommon::Matrix::Data< double > * > &input_data, MLCommon::Matrix::PartDescriptor &input_desc, double *components, std::size_t n_components, cudaStream_t *streams, std::uint32_t n_stream)

Function Documentation

fit() [1/2]

void ML::PCA::opg::fit	(	raft::handle_t &	handle,
		std::vector< MLCommon::Matrix::Data< double > * > &	input_data,
		MLCommon::Matrix::PartDescriptor &	input_desc,
		double *	components,
		double *	explained_var,
		double *	explained_var_ratio,
		double *	singular_vals,
		double *	mu,
		double *	noise_vars,
		paramsPCAMG	prms,
		bool	verbose = false
	)

fit() [2/2]

void ML::PCA::opg::fit	(	raft::handle_t &	handle,
		std::vector< MLCommon::Matrix::Data< float > * > &	input_data,
		MLCommon::Matrix::PartDescriptor &	input_desc,
		float *	components,
		float *	explained_var,
		float *	explained_var_ratio,
		float *	singular_vals,
		float *	mu,
		float *	noise_vars,
		paramsPCAMG	prms,
		bool	verbose = false
	)

performs MNMG fit operation for the pca

Parameters

[in]	handle	the internal cuml handle object
[in]	input_data	input data
[in]	input_desc	descriptor for input data
[out]	components	principal components of the input data
[out]	explained_var	explained var
[out]	explained_var_ratio	the explained var ratio
[out]	singular_vals	singular values of the data
[out]	mu	mean of every column in input
[out]	noise_vars	variance of the noise
[in]	prms	data structure that includes all the parameters from input size to algorithm
[in]	verbose

fit_transform() [1/2]

void ML::PCA::opg::fit_transform	(	raft::handle_t &	handle,
		MLCommon::Matrix::RankSizePair **	rank_sizes,
		std::uint32_t	n_parts,
		MLCommon::Matrix::doubleData_t **	input,
		MLCommon::Matrix::doubleData_t **	trans_input,
		double *	components,
		double *	explained_var,
		double *	explained_var_ratio,
		double *	singular_vals,
		double *	mu,
		double *	noise_vars,
		paramsPCAMG	prms,
		bool	verbose
	)

fit_transform() [2/2]

void ML::PCA::opg::fit_transform	(	raft::handle_t &	handle,
		MLCommon::Matrix::RankSizePair **	rank_sizes,
		std::uint32_t	n_parts,
		MLCommon::Matrix::floatData_t **	input,
		MLCommon::Matrix::floatData_t **	trans_input,
		float *	components,
		float *	explained_var,
		float *	explained_var_ratio,
		float *	singular_vals,
		float *	mu,
		float *	noise_vars,
		paramsPCAMG	prms,
		bool	verbose
	)

performs MNMG fit and transform operation for the pca

Parameters

[in]	handle	the internal cuml handle object
[in]	rank_sizes	includes all the partition size information for the rank
[in]	n_parts	number of partitions
[in]	input	input data
[out]	trans_input	transformed input data
[out]	components	principal components of the input data
[out]	explained_var	explained var
[out]	explained_var_ratio	the explained var ratio
[out]	singular_vals	singular values of the data
[out]	mu	mean of every column in input
[out]	noise_vars	variance of the noise
[in]	prms	data structure that includes all the parameters from input size to algorithm
[in]	verbose

inverse_transform() [1/2]

void ML::PCA::opg::inverse_transform	(	raft::handle_t &	handle,
		MLCommon::Matrix::RankSizePair **	rank_sizes,
		std::uint32_t	n_parts,
		MLCommon::Matrix::Data< double > **	trans_input,
		double *	components,
		MLCommon::Matrix::Data< double > **	input,
		double *	singular_vals,
		double *	mu,
		paramsPCAMG	prms,
		bool	verbose
	)

inverse_transform() [2/2]

void ML::PCA::opg::inverse_transform	(	raft::handle_t &	handle,
		MLCommon::Matrix::RankSizePair **	rank_sizes,
		std::uint32_t	n_parts,
		MLCommon::Matrix::Data< float > **	trans_input,
		float *	components,
		MLCommon::Matrix::Data< float > **	input,
		float *	singular_vals,
		float *	mu,
		paramsPCAMG	prms,
		bool	verbose
	)

performs MNMG inverse transform operation for the pca

Parameters

[in]	handle	the internal cuml handle object
[in]	rank_sizes	includes all the partition size information for the rank
[in]	n_parts	number of partitions
[in]	trans_input	transformed input data
[in]	components	principal components of the input data
[out]	input	input data
[in]	singular_vals	singular values of the data
[in]	mu	mean of every column in input
[in]	prms	data structure that includes all the parameters from input size to algorithm
[in]	verbose

sign_flip() [1/2]

void ML::PCA::opg::sign_flip	(	raft::handle_t &	handle,
		std::vector< MLCommon::Matrix::Data< double > * > &	input_data,
		MLCommon::Matrix::PartDescriptor &	input_desc,
		double *	components,
		std::size_t	n_components,
		cudaStream_t *	streams,
		std::uint32_t	n_stream
	)

sign_flip() [2/2]

void ML::PCA::opg::sign_flip	(	raft::handle_t &	handle,
		std::vector< MLCommon::Matrix::Data< float > * > &	input_data,
		MLCommon::Matrix::PartDescriptor &	input_desc,
		float *	components,
		std::size_t	n_components,
		cudaStream_t *	streams,
		std::uint32_t	n_stream
	)

sign flip for PCA and tSVD. This is used to stabilize the sign of column major eigen vectors

Parameters

[in]	handle	the internal cuml handle object
[in]	input_data	input matrix that will be used to determine the sign.
[in]	input_desc	MNMG description of the input
[out]	components	components matrix.
[in]	n_components	number of columns of components matrix
[in]	streams	cuda streams
[in]	n_stream	number of streams

transform() [1/2]

void ML::PCA::opg::transform	(	raft::handle_t &	handle,
		MLCommon::Matrix::RankSizePair **	rank_sizes,
		std::uint32_t	n_parts,
		MLCommon::Matrix::Data< double > **	input,
		double *	components,
		MLCommon::Matrix::Data< double > **	trans_input,
		double *	singular_vals,
		double *	mu,
		paramsPCAMG	prms,
		bool	verbose
	)

transform() [2/2]

void ML::PCA::opg::transform	(	raft::handle_t &	handle,
		MLCommon::Matrix::RankSizePair **	rank_sizes,
		std::uint32_t	n_parts,
		MLCommon::Matrix::Data< float > **	input,
		float *	components,
		MLCommon::Matrix::Data< float > **	trans_input,
		float *	singular_vals,
		float *	mu,
		paramsPCAMG	prms,
		bool	verbose
	)

performs MNMG transform operation for the pca

Parameters

[in]	handle	the internal cuml handle object
[in]	rank_sizes	includes all the partition size information for the rank
[in]	n_parts	number of partitions
[in]	input	input data
[in]	components	principal components of the input data
[out]	trans_input	transformed input data
[in]	singular_vals	singular values of the data
[in]	mu	mean of every column in input
[in]	prms	data structure that includes all the parameters from input size to algorithm
[in]	verbose