generate_ngrams.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
7 #include <cudf/column/column.hpp>
8 #include <cudf/scalar/scalar.hpp>
10 #include <cudf/utilities/export.hpp>
12 
13 namespace CUDF_EXPORT nvtext {
48 std::unique_ptr<cudf::column> generate_ngrams(
49  cudf::strings_column_view const& input,
50  cudf::size_type ngrams,
51  cudf::string_scalar const& separator,
54 
78 std::unique_ptr<cudf::column> generate_character_ngrams(
79  cudf::strings_column_view const& input,
80  cudf::size_type ngrams = 2,
83 
114 std::unique_ptr<cudf::column> hash_character_ngrams(
115  cudf::strings_column_view const& input,
116  cudf::size_type ngrams = 5,
117  uint32_t seed = 0,
120  // end of group
122 } // namespace CUDF_EXPORT nvtext
An owning class to represent a string in device memory.
Definition: scalar.hpp:410
Given a column-view of strings type, an instance of this class provides a wrapper on this compound co...
Class definition for cudf::column.
rmm::cuda_stream_view 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.
detail::cccl_async_resource_ref< cuda::mr::resource_ref< cuda::mr::device_accessible > > device_async_resource_ref
std::unique_ptr< cudf::column > generate_ngrams(cudf::strings_column_view const &input, cudf::size_type ngrams, cudf::string_scalar const &separator, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a single column of strings by generating ngrams from a strings column.
std::unique_ptr< cudf::column > hash_character_ngrams(cudf::strings_column_view const &input, cudf::size_type ngrams=5, uint32_t seed=0, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Hashes ngrams of characters within each string.
std::unique_ptr< cudf::column > generate_character_ngrams(cudf::strings_column_view const &input, cudf::size_type ngrams=2, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Generates ngrams of characters within each string.
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:84
NVText APIs.
Class definitions for cudf::scalar.
Class definition for cudf::strings_column_view.