Skip to content

Commit

Permalink
Rename libcudf++ to libcudf. (#11953)
Browse files Browse the repository at this point in the history
For consistency across our documentation, this PR renames `libcudf++` to `libcudf`.

Authors:
  - Bradley Dice (https://github.com/bdice)
  - Vyas Ramasubramani (https://github.com/vyasr)

Approvers:
  - David Wendt (https://github.com/davidwendt)
  - GALI PREM SAGAR (https://github.com/galipremsagar)
  - Vyas Ramasubramani (https://github.com/vyasr)
  - Nghia Truong (https://github.com/ttnghia)

URL: #11953
  • Loading branch information
bdice authored Oct 20, 2022
1 parent ee9ffd0 commit 5803015
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions cpp/doxygen/developer_guide/DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Resource ownership is an essential concept in libcudf. In short, an "owning" obj
resource (such as device memory). It acquires that resource during construction and releases the
resource in destruction ([RAII](https://en.cppreference.com/w/cpp/language/raii)). A "non-owning"
object does not own resources. Any class in libcudf with the `*_view` suffix is non-owning. For more
detail see the [`libcudf++` presentation.](https://docs.google.com/presentation/d/1zKzAtc1AWFKfMhiUlV5yRZxSiPLwsObxMlWRWz_f5hA/edit?usp=sharing)
detail see the [`libcudf` presentation.](https://docs.google.com/presentation/d/1zKzAtc1AWFKfMhiUlV5yRZxSiPLwsObxMlWRWz_f5hA/edit?usp=sharing)
libcudf functions typically take views as input (`column_view` or `table_view`)
and produce `unique_ptr`s to owning objects as output. For example,
Expand Down Expand Up @@ -403,7 +403,7 @@ Functions like merge or groupby in libcudf make no guarantees about the order of
Promising deterministic ordering is not, in general, conducive to fast parallel algorithms.
Calling code is responsible for performing sorts after the fact if sorted outputs are needed.

# libcudf++ API and Implementation
# libcudf API and Implementation

## Streams

Expand Down
2 changes: 1 addition & 1 deletion cpp/doxygen/developer_guide/DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# libcudf++ C++ Documentation Guide
# libcudf C++ Documentation Guide

These guidelines apply to documenting all libcudf C++ source files using doxygen style formatting although only public APIs and classes are actually [published](https://docs.rapids.ai/api/libcudf/stable/index.html).

Expand Down
4 changes: 2 additions & 2 deletions python/cudf/cudf/_lib/avro.pyx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2020, NVIDIA CORPORATION.
# Copyright (c) 2020-2022, NVIDIA CORPORATION.

from libcpp.string cimport string
from libcpp.utility cimport move
Expand All @@ -16,7 +16,7 @@ from cudf._lib.utils cimport data_from_unique_ptr

cpdef read_avro(datasource, columns=None, skip_rows=-1, num_rows=-1):
"""
Cython function to call libcudf++ read_avro, see `read_avro`.
Cython function to call libcudf read_avro, see `read_avro`.
See Also
--------
Expand Down
6 changes: 3 additions & 3 deletions python/cudf/cudf/_lib/io/utils.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import cudf
from cudf.api.types import is_struct_dtype


# Converts the Python source input to libcudf++ IO source_info
# Converts the Python source input to libcudf IO source_info
# with the appropriate type and source values
cdef source_info make_source_info(list src) except*:
if not src:
Expand Down Expand Up @@ -80,7 +80,7 @@ cdef source_info make_source_info(list src) except*:

return source_info(c_host_buffers)

# Converts the Python sink input to libcudf++ IO sink_info.
# Converts the Python sink input to libcudf IO sink_info.
cdef sink_info make_sinks_info(
list src, vector[unique_ptr[data_sink]] & sink
) except*:
Expand Down Expand Up @@ -129,7 +129,7 @@ cdef sink_info make_sink_info(src, unique_ptr[data_sink] & sink) except*:
return info


# Adapts a python io.IOBase object as a libcudf++ IO data_sink. This lets you
# Adapts a python io.IOBase object as a libcudf IO data_sink. This lets you
# write from cudf to any python file-like object (File/BytesIO/SocketIO etc)
cdef cppclass iobase_data_sink(data_sink):
object buf
Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/_lib/json.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ cpdef read_json(object filepaths_or_buffers,

# If input data is a JSON string (or StringIO), hold a reference to
# the encoded memoryview externally to ensure the encoded buffer
# isn't destroyed before calling libcudf++ `read_json()`
# isn't destroyed before calling libcudf `read_json()`
for idx in range(len(filepaths_or_buffers)):
if isinstance(filepaths_or_buffers[idx], io.StringIO):
filepaths_or_buffers[idx] = \
Expand Down
6 changes: 3 additions & 3 deletions python/cudf/cudf/_lib/reduce.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ cimport cudf._lib.cpp.types as libcudf_types

def reduce(reduction_op, Column incol, dtype=None, **kwargs):
"""
Top level Cython reduce function wrapping libcudf++ reductions.
Top level Cython reduce function wrapping libcudf reductions.
Parameters
----------
Expand Down Expand Up @@ -91,7 +91,7 @@ def reduce(reduction_op, Column incol, dtype=None, **kwargs):

def scan(scan_op, Column incol, inclusive, **kwargs):
"""
Top level Cython scan function wrapping libcudf++ scans.
Top level Cython scan function wrapping libcudf scans.
Parameters
----------
Expand Down Expand Up @@ -122,7 +122,7 @@ def scan(scan_op, Column incol, inclusive, **kwargs):

def minmax(Column incol):
"""
Top level Cython minmax function wrapping libcudf++ minmax.
Top level Cython minmax function wrapping libcudf minmax.
Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -1412,7 +1412,7 @@ def searchsorted(
>>> df.searchsorted(values_df, ascending=False)
array([4, 4, 4, 0], dtype=int32)
"""
# Call libcudf++ search_sorted primitive
# Call libcudf search_sorted primitive

if na_position not in {"first", "last"}:
raise ValueError(f"invalid na_position: {na_position}")
Expand Down

0 comments on commit 5803015

Please sign in to comment.