Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #218

Merged
merged 3 commits into from
May 23, 2023
Merged

Update docs #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef75b99
Update docs
madsbk May 12, 2023
f1e4bb9
kvikiIO => KvikIO
madsbk May 12, 2023
9c79824
Merge branch 'branch-23.06' into docs
madsbk May 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,7 @@ conda env create --name kvikio-dev --file conda/environments/all_cuda-118_arch-x
To build the C++ example, go to the `cpp` subdiretory and run:

```
mkdir build
cd build
cmake ..
make
./build.sh libkvikio
```

Then run the example:
Expand All @@ -87,7 +84,7 @@ Then run the example:
To build and install the extension, go to the `python` subdirectory and run:

```
python -m pip install .
./build.sh kvikio
```

One might have to define `CUDA_HOME` to the path to the CUDA installation.
Expand Down
4 changes: 2 additions & 2 deletions ci/docs/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
# Copyright (c) 2022-2023, NVIDIA CORPORATION.
###################################
# kvikIO Docs build script for CI #
# KvikIO Docs build script for CI #
###################################

if [ -z "$PROJECT_WORKSPACE" ]; then
Expand All @@ -27,7 +27,7 @@ gpuci_logger "Activate conda env"
. /opt/conda/etc/profile.d/conda.sh
conda activate rapids

gpuci_logger "Install kvikIO"
gpuci_logger "Install KvikIO"
gpuci_conda_retry install -y -c rapidsai-nightly kvikio

gpuci_logger "Check versions"
Expand Down
2 changes: 1 addition & 1 deletion ci/release/update-version.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
# Copyright (c) 2022-2023, NVIDIA CORPORATION.
##########################
# kvikIO Version Updater #
# KvikIO Version Updater #
##########################

## Usage
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Welcome to kvikIO's documentation!
Welcome to KvikIO's documentation!
==================================

kvikIO is a Python library providing bindings to `cuFile <https://docs.nvidia.com/gpudirect-storage/api-reference-guide/index.html>`_, which enables `GPUDirectStorage <https://developer.nvidia.com/blog/gpudirect-storage/>`_ (GDS).
KvikIO is a Python library providing bindings to `cuFile <https://docs.nvidia.com/gpudirect-storage/api-reference-guide/index.html>`_, which enables `GPUDirectStorage <https://developer.nvidia.com/blog/gpudirect-storage/>`_ (GDS).

.. toctree::
:maxdepth: 2
Expand Down