Binary

Source header: cuvs/preprocessing/quantize/binary.hpp

Binary quantizer utilities

preprocessing::quantize::binary::bit_threshold

quantizer algorithms. The mean and sampling_median thresholds are calculated separately

for each dimension.

1
enum class bit_threshold { ... };

Values

preprocessing::quantize::binary::params

quantizer parameters.

1
struct params { ... };

Fields

preprocessing::quantize::binary::quantizer

Store the threshold vector for quantization. In the binary::transform function, a bit is

set if the corresponding element in the dataset vector is greater than the corresponding element in the threshold vector.

1
template <typename T>
2
struct quantizer { ... };

Fields

preprocessing::quantize::binary::quantizer::quantizer

Construct a quantizer with an empty threshold vector.

1
quantizer(raft::resources const& res) : threshold(raft::make_device_vector<T, int64_t>(res, 0));

Parameters

Returns

void

preprocessing::quantize::binary::train

Initializes a binary quantizer to be used later for quantizing the dataset.

1
quantizer<double> train(raft::resources const& res,
2
const params params,
3
raft::device_matrix_view<const double, int64_t> dataset);

Usage example:

Parameters

Returns

quantizer<double>

Additional overload: preprocessing::quantize::binary::train

Initializes a binary quantizer to be used later for quantizing the dataset.

1
quantizer<double> train(raft::resources const& res,
2
const params params,
3
raft::host_matrix_view<const double, int64_t> dataset);

Usage example:

Parameters

Returns

quantizer<double>

preprocessing::quantize::binary::transform

Applies binary quantization transform to given dataset. If a dataset element is positive,

1
void transform(raft::resources const& res,
2
const quantizer<double>& quantizer,
3
raft::device_matrix_view<const double, int64_t> dataset,
4
raft::device_matrix_view<uint8_t, int64_t> out);

set the corresponding bit to 1.

Usage example:

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::transform

Applies binary quantization transform to given dataset. If a dataset element is positive,

1
void transform(raft::resources const& res,
2
const quantizer<double>& quantizer,
3
raft::host_matrix_view<const double, int64_t> dataset,
4
raft::host_matrix_view<uint8_t, int64_t> out);

set the corresponding bit to 1.

Usage example:

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::train

Initializes a binary quantizer to be used later for quantizing the dataset.

1
quantizer<float> train(raft::resources const& res,
2
const params params,
3
raft::device_matrix_view<const float, int64_t> dataset);

Usage example:

Parameters

Returns

quantizer<float>

Additional overload: preprocessing::quantize::binary::train

Initializes a binary quantizer to be used later for quantizing the dataset.

1
quantizer<float> train(raft::resources const& res,
2
const params params,
3
raft::host_matrix_view<const float, int64_t> dataset);

Usage example:

Parameters

Returns

quantizer<float>

Additional overload: preprocessing::quantize::binary::transform

Applies binary quantization transform to given dataset. If a dataset element is positive,

1
void transform(raft::resources const& res,
2
const quantizer<float>& quantizer,
3
raft::device_matrix_view<const float, int64_t> dataset,
4
raft::device_matrix_view<uint8_t, int64_t> out);

set the corresponding bit to 1.

Usage example:

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::transform

Applies binary quantization transform to given dataset. If a dataset element is positive,

1
void transform(raft::resources const& res,
2
const quantizer<float>& quantizer,
3
raft::host_matrix_view<const float, int64_t> dataset,
4
raft::host_matrix_view<uint8_t, int64_t> out);

set the corresponding bit to 1.

Usage example:

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::train

Initializes a binary quantizer to be used later for quantizing the dataset.

1
quantizer<half> train(raft::resources const& res,
2
const params params,
3
raft::device_matrix_view<const half, int64_t> dataset);

Usage example:

Parameters

Returns

quantizer<half>

Additional overload: preprocessing::quantize::binary::train

Initializes a binary quantizer to be used later for quantizing the dataset.

1
quantizer<half> train(raft::resources const& res,
2
const params params,
3
raft::host_matrix_view<const half, int64_t> dataset);

Usage example:

Parameters

Returns

quantizer<half>

Additional overload: preprocessing::quantize::binary::transform

Applies binary quantization transform to given dataset.

1
void transform(raft::resources const& res,
2
const quantizer<half>& quantizer,
3
raft::device_matrix_view<const half, int64_t> dataset,
4
raft::device_matrix_view<uint8_t, int64_t> out);

Usage example:

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::transform

Applies binary quantization transform to given dataset.

1
void transform(raft::resources const& res,
2
const quantizer<half>& quantizer,
3
raft::host_matrix_view<const half, int64_t> dataset,
4
raft::host_matrix_view<uint8_t, int64_t> out);

Usage example:

Parameters

Returns

void

preprocessing::quantize::binary::[[deprecated

[deprecated] Applies binary quantization transform to given dataset. If a dataset element

1
[[deprecated("please create and specify a quantizer")]] void transform(
2
raft::resources const& res,
3
raft::device_matrix_view<const double, int64_t> dataset,
4
raft::device_matrix_view<uint8_t, int64_t> out);

is positive, set the corresponding bit to 1.

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::[[deprecated

[deprecated] Applies binary quantization transform to given dataset. If a dataset element

1
[[deprecated("please create and specify a quantizer")]] void transform(
2
raft::resources const& res,
3
raft::host_matrix_view<const double, int64_t> dataset,
4
raft::host_matrix_view<uint8_t, int64_t> out);

is positive, set the corresponding bit to 1.

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::[[deprecated

[deprecated] Applies binary quantization transform to given dataset. If a dataset element

1
[[deprecated("please create and specify a quantizer")]] void transform(
2
raft::resources const& res,
3
raft::device_matrix_view<const float, int64_t> dataset,
4
raft::device_matrix_view<uint8_t, int64_t> out);

is positive, set the corresponding bit to 1.

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::[[deprecated

[deprecated] Applies binary quantization transform to given dataset. If a dataset element

1
[[deprecated("please create and specify a quantizer")]] void transform(
2
raft::resources const& res,
3
raft::host_matrix_view<const float, int64_t> dataset,
4
raft::host_matrix_view<uint8_t, int64_t> out);

is positive, set the corresponding bit to 1.

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::[[deprecated

[deprecated] Applies binary quantization transform to given dataset. If a dataset element

1
[[deprecated("please create and specify a quantizer")]] void transform(
2
raft::resources const& res,
3
raft::device_matrix_view<const half, int64_t> dataset,
4
raft::device_matrix_view<uint8_t, int64_t> out);

is positive, set the corresponding bit to 1.

Parameters

Returns

void

Additional overload: preprocessing::quantize::binary::[[deprecated

[deprecated] Applies binary quantization transform to given dataset. If a dataset element

1
[[deprecated("please create and specify a quantizer")]] void transform(
2
raft::resources const& res,
3
raft::host_matrix_view<const half, int64_t> dataset,
4
raft::host_matrix_view<uint8_t, int64_t> out);

is positive, set the corresponding bit to 1.

Parameters

Returns

void