add doc

rapidsai · Feb 5, 2025 · c717721 · c717721
1 parent 46c8ec5
commit c717721
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 0 deletions.
diff --git a/python/pylibcudf/pylibcudf/io/avro.pyx b/python/pylibcudf/pylibcudf/io/avro.pyx
@@ -143,6 +143,8 @@ cpdef TableWithMetadata read_avro(
     ----------
     options: AvroReaderOptions
         Settings for controlling reading behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
     """
     with nogil:
         if stream is not None:

diff --git a/python/pylibcudf/pylibcudf/io/csv.pyx b/python/pylibcudf/pylibcudf/io/csv.pyx
@@ -645,6 +645,8 @@ cpdef TableWithMetadata read_csv(
     ----------
     options: CsvReaderOptions
         Settings for controlling reading behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
     """
     cdef table_with_metadata c_result
     with nogil:
@@ -851,6 +853,8 @@ cpdef void write_csv(
     ----------
     options: CsvWriterOptions
         Settings for controlling writing behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
     """
     with nogil:
         if stream is not None:

diff --git a/python/pylibcudf/pylibcudf/io/json.pyx b/python/pylibcudf/pylibcudf/io/json.pyx
@@ -436,6 +436,8 @@ cpdef tuple chunked_read_json(
     chunk_size : int, default 100_000_000 bytes.
         The number of bytes to be read in chunks.
         The chunk_size should be set to at least row_size.
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
 
     Returns
     -------
@@ -504,6 +506,8 @@ cpdef TableWithMetadata read_json(
     ----------
     options: JsonReaderOptions
         Settings for controlling reading behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
 
     Returns
     -------
@@ -712,6 +716,8 @@ cpdef void write_json(JsonWriterOptions options, Stream stream = None):
     ----------
     options : JsonWriterOptions
         Settings for controlling writing behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
 
     Returns
     -------

diff --git a/python/pylibcudf/pylibcudf/io/orc.pyx b/python/pylibcudf/pylibcudf/io/orc.pyx
@@ -420,6 +420,8 @@ cpdef TableWithMetadata read_orc(OrcReaderOptions options, Stream stream = None)
     ----------
     options: OrcReaderOptions
         Settings for controlling reading behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
     """
     cdef table_with_metadata c_result
 
@@ -622,6 +624,8 @@ cpdef void write_orc(OrcWriterOptions options, Stream stream = None):
     ----------
     options: OrcWriterOptions
         Settings for controlling writing behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
 
     Returns
     -------
@@ -671,6 +675,8 @@ cdef class OrcChunkedWriter:
         ----------
         options: ChunkedOrcWriterOptions
             Settings for controlling writing behavior
+        stream: Stream
+            CUDA stream used for device memory operations and kernel launches
 
         Returns
         -------

diff --git a/python/pylibcudf/pylibcudf/io/parquet.pyx b/python/pylibcudf/pylibcudf/io/parquet.pyx
@@ -320,6 +320,8 @@ cpdef read_parquet(ParquetReaderOptions options, Stream stream = None):
     ----------
     options: ParquetReaderOptions
         Settings for controlling reading behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
     """
     with nogil:
         if stream is not None:
@@ -390,6 +392,8 @@ cdef class ParquetChunkedWriter:
         ----------
         options: ChunkedParquetWriterOptions
             Settings for controlling writing behavior
+        stream: Stream
+            CUDA stream used for device memory operations and kernel launches
 
         Returns
         -------
@@ -935,6 +939,8 @@ cpdef memoryview write_parquet(ParquetWriterOptions options, Stream stream = Non
     ----------
     options : ParquetWriterOptions
         Settings for controlling writing behavior
+    stream: Stream
+        CUDA stream used for device memory operations and kernel launches
 
     Returns
     -------