normalize.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2020-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
7 #include <cudf/column/column.hpp>
10 #include <cudf/utilities/export.hpp>
12 
13 #include <cuda/stream>
14 
16 namespace CUDF_EXPORT nvtext {
47 std::unique_ptr<cudf::column> normalize_spaces(
48  cudf::strings_column_view const& input,
49  cuda::stream_ref stream = cudf::get_default_stream(),
51 
97  character_normalizer(bool do_lower_case,
98  cudf::strings_column_view const& special_tokens,
99  cuda::stream_ref stream = cudf::get_default_stream(),
102 
103  struct character_normalizer_impl;
104  std::unique_ptr<character_normalizer_impl> _impl;
105 };
106 
124 std::unique_ptr<character_normalizer> create_character_normalizer(
125  bool do_lower_case,
127  cudf::data_type{cudf::type_id::STRING}, 0, nullptr, nullptr, 0}),
128  cuda::stream_ref stream = cudf::get_default_stream(),
130 
156 std::unique_ptr<cudf::column> normalize_characters(
157  cudf::strings_column_view const& input,
158  character_normalizer const& normalizer,
159  cuda::stream_ref stream = cudf::get_default_stream(),
161  // end of group
163 } // namespace CUDF_EXPORT nvtext
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Indicator for the logical data type of an element in a column.
Definition: types.hpp:279
Given a column-view of strings type, an instance of this class provides a wrapper on this compound co...
Class definition for cudf::column.
column view class definitions
cuda::stream_ref const get_default_stream()
Get the current default stream.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
std::unique_ptr< character_normalizer > create_character_normalizer(bool do_lower_case, cudf::strings_column_view const &special_tokens=cudf::strings_column_view(cudf::column_view{ cudf::data_type{cudf::type_id::STRING}, 0, nullptr, nullptr, 0}), cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a normalizer object.
std::unique_ptr< cudf::column > normalize_spaces(cudf::strings_column_view const &input, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a new strings column by normalizing the whitespace in each string in the input column.
std::unique_ptr< cudf::column > normalize_characters(cudf::strings_column_view const &input, character_normalizer const &normalizer, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Normalizes the text in input strings column.
@ STRING
String elements.
APIs for getting and setting the current device memory resource.
NVText APIs.
Class definition for cudf::strings_column_view.
Normalizer object to be used with nvtext::normalize_characters.
Definition: normalize.hpp:81
character_normalizer(bool do_lower_case, cudf::strings_column_view const &special_tokens, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Normalizer object constructor.