From d9ed1ba48824e2ffd4cd62b83e3abe2f785ea3f0 Mon Sep 17 00:00:00 2001 From: iskode Date: Thu, 12 Aug 2021 11:21:55 +0000 Subject: [PATCH 01/28] doc restructuration --- CONTRIBUTING.md | 227 ++++++++++++++++++++++-------------------------- 1 file changed, 105 insertions(+), 122 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 841a02f72e6..691ba92d4e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,79 +55,9 @@ implementation of the issue, ask them in the issue instead of the PR. The following instructions are for developers and contributors to cuDF OSS development. These instructions are tested on Linux Ubuntu 16.04 & 18.04. Use these instructions to build cuDF from source and contribute to its development. Other operating systems may be compatible, but are not currently tested. -### Code Formatting - -#### Python - -cuDF uses [Black](https://black.readthedocs.io/en/stable/), -[isort](https://readthedocs.org/projects/isort/), and -[flake8](http://flake8.pycqa.org/en/latest/) to ensure a consistent code format -throughout the project. `Black`, `isort`, and `flake8` can be installed with -`conda` or `pip`: - -```bash -conda install black isort flake8 -``` - -```bash -pip install black isort flake8 -``` - -These tools are used to auto-format the Python code, as well as check the Cython -code in the repository. Additionally, there is a CI check in place to enforce -that committed code follows our standards. You can use the tools to -automatically format your python code by running: - -```bash -isort --atomic python/**/*.py -black python -``` - -and then check the syntax of your Python and Cython code by running: - -```bash -flake8 python -flake8 --config=python/.flake8.cython -``` - -Additionally, many editors have plugins that will apply `isort` and `Black` as -you edit files, as well as use `flake8` to report any style / syntax issues. - -#### C++/CUDA - -cuDF uses [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) - -In order to format the C++/CUDA files, navigate to the root (`cudf`) directory and run: -``` -python3 ./cpp/scripts/run-clang-format.py -inplace -``` - -Additionally, many editors have plugins or extensions that you can set up to automatically run `clang-format` either manually or on file save. - -#### Pre-commit hooks - -Optionally, you may wish to setup [pre-commit hooks](https://pre-commit.com/) -to automatically run `isort`, `Black`, `flake8` and `clang-format` when you make a git commit. -This can be done by installing `pre-commit` via `conda` or `pip`: - -```bash -conda install -c conda-forge pre_commit -``` - -```bash -pip install pre-commit -``` - -and then running: - -```bash -pre-commit install -``` -from the root of the cuDF repository. Now `isort`, `Black`, `flake8` and `clang-format` will be -run each time you commit changes. -### Get libcudf Dependencies +### General dependency requirements Compiler requirements: @@ -143,11 +73,7 @@ CUDA/GPU requirements: You can obtain CUDA from [https://developer.nvidia.com/cuda-downloads](https://developer.nvidia.com/cuda-downloads). -## Script to build cuDF from source - -### Build from Source - -To install cuDF from source, ensure the dependencies are met and follow the steps below: +### Create the build Environment - Clone the repository and submodules ```bash @@ -166,86 +92,77 @@ conda activate cudf_dev ``` - For other CUDA versions, check the corresponding cudf_dev_cuda*.yml file in conda/environments -- Build and install `libcudf` after its dependencies. CMake depends on the `nvcc` executable being on your path or defined in `$CUDACXX`. -```bash -$ cd $CUDF_HOME/cpp # navigate to C/C++ CUDA source root directory -$ mkdir build # make a build directory -$ cd build # enter the build directory - -# CMake options: -# -DCMAKE_INSTALL_PREFIX set to the install path for your libraries or $CONDA_PREFIX if you're using Anaconda, i.e. -DCMAKE_INSTALL_PREFIX=/install/path or -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX -$ cmake .. -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX # configure cmake ... -$ make -j # compile the libraries librmm.so, libcudf.so ... '-j' will start a parallel job using the number of physical cores available on your system -$ make install # install the libraries librmm.so, libcudf.so to the CMAKE_INSTALL_PREFIX -``` +### Build cuDF from Source -- As a convenience, a `build.sh` script is provided in `$CUDF_HOME`. To execute the same build commands above, run the script as shown below. Note that the libraries will be installed to the location set in `$INSTALL_PREFIX` if set (i.e. `export INSTALL_PREFIX=/install/path`), otherwise to `$CONDA_PREFIX`. +- A `build.sh` script is provided in `$CUDF_HOME`. Note that CMake depends on the `nvcc` executable being on your path or defined in `$CUDACXX` and the libraries will be installed to the location set in `$INSTALL_PREFIX` if set (i.e. `export INSTALL_PREFIX=/install/path`), otherwise to `$CONDA_PREFIX`. ```bash $ cd $CUDF_HOME -$ ./build.sh # To build both C++ and Python cuDF versions with their dependencies +$./build.sh libcudf ``` -- To build only the C++ component with the script +- Many other librairies like `dask-cudf` and `cudf-kafka` can be installed with this script. For the complete list of librairies as well as details about the script usage, run the `help` command: ```bash -$ ./build.sh libcudf # Build only the cuDF C++ components and install them to $INSTALL_PREFIX if set, otherwise $CONDA_PREFIX +$ cd $CUDF_HOME +$./build.sh --help ``` -- To run tests (Optional): +### Install and Test cuDF for contributors + +The general workflow is to find your contributor profile (C++ or Python, etc...), then follow the corresponding instructions and finally go to the last section about [code formatting](###code-formatting). + +#### Any contributor: + +This section provides instructions for building and testing C++ libcudf. Thus, C++ libcudf only contributor will be all set after following instructions below: + ```bash -$ make test +$ cd $CUDF_HOME +$ # for C++ contributors +$./build.sh libcudf tests # building C++ cuDF and test components +$ make test # running C++ cuDF unit tests +$ # for other contributors +$./build.sh libcudf ``` -- Build the `cudf` python package, in the `python/cudf` folder: + +#### Python cudf contributors: + +- To build and install in edit/develop mode the `cudf` python package, in the `python/cudf` folder: ```bash $ cd $CUDF_HOME/python/cudf $ python setup.py build_ext --inplace -$ python setup.py install +$ python setup.py develop ``` -- Like the `libcudf` build step above, `build.sh` can also be used to build the `cudf` python package, as shown below: +- To run `cudf` tests : ```bash -$ cd $CUDF_HOME -$ ./build.sh cudf +$ cd $CUDF_HOME/python +$ py.test -v cudf/cudf/tests # run cudf test suite ``` -- Additionally to build the `dask-cudf` python package, in the `python/dask_cudf` folder: -```bash -$ cd $CUDF_HOME/python/dask_cudf -$ python setup.py install -``` +#### Python dask-cudf contributors: -- The `build.sh` script can also be used to build the `dask-cudf` python package, as shown below: +- To build and install in edit/develop mode the `dask-cudf` python package, in the `python/dask_cudf` folder: ```bash -$ cd $CUDF_HOME -$ ./build.sh dask_cudf +$ cd $CUDF_HOME/python/dask_cudf +$ python setup.py develop ``` -- To run Python tests (Optional): +- To run `dask_cudf` tests : ```bash $ cd $CUDF_HOME/python -$ py.test -v cudf # run cudf test suite -$ py.test -v dask_cudf # run dask_cudf test suite +$ py.test -v dask_cudf # run dask_cudf test suite ``` -- Other `build.sh` options: -```bash -$ cd $CUDF_HOME -$ ./build.sh clean # remove any prior build artifacts and configuration (start over) -$ ./build.sh libcudf -v # compile and install libcudf with verbose output -$ ./build.sh libcudf -g # compile and install libcudf for debug -$ PARALLEL_LEVEL=4 ./build.sh libcudf # compile and install libcudf limiting parallel build jobs to 4 (make -j4) -$ ./build.sh libcudf -n # compile libcudf but do not install -``` -Done! You are ready to develop for the cuDF OSS project. +Done! You are ready to develop for the cuDF OSS project. But please go to [code formatting](###code-formatting) to ensure that you contributing code follows the expected format. ## Debugging cuDF ### Building Debug mode from source -Follow the [above instructions](#build-from-source) to build from source and add `-DCMAKE_BUILD_TYPE=Debug` to the `cmake` step. +Follow the [above instructions](####build-cudf-from-source) to build from source and add `-g` to the `./build.sh` command. For example: ```bash -$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/path -DCMAKE_BUILD_TYPE=Debug # configure cmake ... use -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX if you're using Anaconda +$ ./build.sh libcudf -g ``` This builds `libcudf` in Debug mode which enables some `assert` safety checks and includes symbols in the library for debugging. @@ -289,6 +206,7 @@ You can then use `cuda-dbg` to debug into the kernels in that source file. Before submitting a pull request, you can do a local build and test on your machine that mimics our gpuCI environment using the `ci/local/build.sh` script. For detailed information on usage of this script, see [here](ci/local/README.md). + ## Automated Build in Docker Container A Dockerfile is provided with a preconfigured conda environment for building and installing cuDF from source based off of the main branch. @@ -337,6 +255,71 @@ flag. Below is a list of the available arguments and their purpose: | `CYTHON_VERSION` | 0.29 | Not supported | set Cython version | | `PYTHON_VERSION` | 3.7 | 3.8 | set python version | + +### Code Formatting + + +#### Python + +cuDF uses [Black](https://black.readthedocs.io/en/stable/), +[isort](https://readthedocs.org/projects/isort/), and +[flake8](http://flake8.pycqa.org/en/latest/) to ensure a consistent code format +throughout the project. They have been installed during the `cudf_dev` environment creation. + +These tools are used to auto-format the Python code, as well as check the Cython +code in the repository. Additionally, there is a CI check in place to enforce +that committed code follows our standards. You can use the tools to +automatically format your python code by running: + +```bash +isort --atomic python/**/*.py +black python +``` + +and then check the syntax of your Python and Cython code by running: + +```bash +flake8 python +flake8 --config=python/.flake8.cython +``` + +Additionally, many editors have plugins that will apply `isort` and `Black` as +you edit files, as well as use `flake8` to report any style / syntax issues. + +#### C++/CUDA + +cuDF uses [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) + +In order to format the C++/CUDA files, navigate to the root (`cudf`) directory and run: +``` +python3 ./cpp/scripts/run-clang-format.py -inplace +``` + +Additionally, many editors have plugins or extensions that you can set up to automatically run `clang-format` either manually or on file save. + +#### Pre-commit hooks + +Optionally, you may wish to setup [pre-commit hooks](https://pre-commit.com/) +to automatically run `isort`, `Black`, `flake8` and `clang-format` when you make a git commit. +This can be done by installing `pre-commit` via `conda` or `pip`: + +```bash +conda install -c conda-forge pre_commit +``` + +```bash +pip install pre-commit +``` + +and then running: + +```bash +pre-commit install +``` + +from the root of the cuDF repository. Now `isort`, `Black`, `flake8` and `clang-format` will be +run each time you commit changes. + --- ## Attribution From 23ea87cbd23a9e39217054f150eddedd85344668 Mon Sep 17 00:00:00 2001 From: iskode Date: Fri, 13 Aug 2021 10:17:13 +0000 Subject: [PATCH 02/28] dependency + build-from-source updates --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 691ba92d4e7..103b3bb36f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,15 +57,15 @@ The following instructions are for developers and contributors to cuDF OSS devel -### General dependency requirements +### General requirements -Compiler requirements: +Compilers: * `gcc` version 9.3+ * `nvcc` version 11.0+ * `cmake` version 3.20.1+ -CUDA/GPU requirements: +CUDA/GPU: * CUDA 11.0+ * NVIDIA driver 450.80.02+ @@ -94,7 +94,7 @@ conda activate cudf_dev ### Build cuDF from Source -- A `build.sh` script is provided in `$CUDF_HOME`. Note that CMake depends on the `nvcc` executable being on your path or defined in `$CUDACXX` and the libraries will be installed to the location set in `$INSTALL_PREFIX` if set (i.e. `export INSTALL_PREFIX=/install/path`), otherwise to `$CONDA_PREFIX`. +- A `build.sh` script is provided in `$CUDF_HOME`. Running the script with no additional arguments will install the `libcudf`, `cudf` and `dask_cudf` libraries. By default, the libraries are installed to the `$CONDA_PREFIX` directory. To install into a different location, set the location in `$INSTALL_PREFIX`. Finally, note that the script depends on the `nvcc` executable being on your path, or defined in `$CUDACXX`. ```bash $ cd $CUDF_HOME $./build.sh libcudf From 0a0b0aba276045e4643519600e9fc0d76f1dbe5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:22:45 +0100 Subject: [PATCH 03/28] emphasis on env files Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 103b3bb36f6..ed9057babaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,7 @@ conda env create --name cudf_dev --file conda/environments/cudf_dev_cuda11.0.yml # activate the environment conda activate cudf_dev ``` -- For other CUDA versions, check the corresponding cudf_dev_cuda*.yml file in conda/environments +- For other CUDA versions, check the corresponding `cudf_dev_cuda*.yml` file in conda/environments ### Build cuDF from Source From edf19e9f87aee0ca2b04f19c02405d0fc665cd52 Mon Sep 17 00:00:00 2001 From: iskode Date: Fri, 13 Aug 2021 10:30:55 +0000 Subject: [PATCH 04/28] build-from-source instruction updates --- CONTRIBUTING.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 103b3bb36f6..5a8f5ebdfca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,8 +96,15 @@ conda activate cudf_dev - A `build.sh` script is provided in `$CUDF_HOME`. Running the script with no additional arguments will install the `libcudf`, `cudf` and `dask_cudf` libraries. By default, the libraries are installed to the `$CONDA_PREFIX` directory. To install into a different location, set the location in `$INSTALL_PREFIX`. Finally, note that the script depends on the `nvcc` executable being on your path, or defined in `$CUDACXX`. ```bash -$ cd $CUDF_HOME -$./build.sh libcudf +cd $CUDF_HOME + +# Choose one of the following commands, depending on whether +# you want to build and install the libcudf C++ library only, +# or include the cudf and/or dask_cudf Python libraries: + +./build.sh # libcudf, cudf and dask_cudf +./build.sh libcudf # libcudf only +./build.sh libcudf cudf # libcudf and cudf only ``` - Many other librairies like `dask-cudf` and `cudf-kafka` can be installed with this script. For the complete list of librairies as well as details about the script usage, run the `help` command: ```bash From e03693dfc567b9ab84d556126ff5a0cf1f1a6d01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:44:25 +0100 Subject: [PATCH 05/28] Update `Python cudf contributor` title Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fcd2c12ba8..4b2d4f0b9e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,7 +129,7 @@ $ # for other contributors $./build.sh libcudf ``` -#### Python cudf contributors: +#### Building and testing the `cudf` Python library - To build and install in edit/develop mode the `cudf` python package, in the `python/cudf` folder: ```bash From ec951fb722c482fe8473aa51b57bc0a65dbfbcb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:46:04 +0100 Subject: [PATCH 06/28] workflow paragraph update Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b2d4f0b9e0..97e380f4f07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,7 +114,7 @@ $./build.sh --help ### Install and Test cuDF for contributors -The general workflow is to find your contributor profile (C++ or Python, etc...), then follow the corresponding instructions and finally go to the last section about [code formatting](###code-formatting). +The general workflow for building and testing the C++ and Python components of cuDF are provided below. Please also see the last section about [code formatting](###code-formatting). #### Any contributor: From 6e1d901374aed6c7eef7440b8badd1090a55704c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:47:11 +0100 Subject: [PATCH 07/28] update `Any contributor` title Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97e380f4f07..83c0eb2c0ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -116,7 +116,7 @@ $./build.sh --help The general workflow for building and testing the C++ and Python components of cuDF are provided below. Please also see the last section about [code formatting](###code-formatting). -#### Any contributor: +#### Building and testing the `libcudf` C++ library This section provides instructions for building and testing C++ libcudf. Thus, C++ libcudf only contributor will be all set after following instructions below: From 45b016993966d0785d24011f455bc58c217e11fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:50:30 +0100 Subject: [PATCH 08/28] remove `build` in `dask-cudf` installation paragraph Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83c0eb2c0ad..e5dfbcd3cd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -146,7 +146,7 @@ $ py.test -v cudf/cudf/tests # run cudf test suite #### Python dask-cudf contributors: -- To build and install in edit/develop mode the `dask-cudf` python package, in the `python/dask_cudf` folder: +- To install in edit/develop mode the `dask-cudf` python package: ```bash $ cd $CUDF_HOME/python/dask_cudf $ python setup.py develop From f4e94519fd2076fae864a2542b736bcf3c8fff69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:54:02 +0100 Subject: [PATCH 09/28] Remove `cd $CUDF_HOME` in build-from-source Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5dfbcd3cd3..dcb50892498 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,8 +108,7 @@ cd $CUDF_HOME ``` - Many other librairies like `dask-cudf` and `cudf-kafka` can be installed with this script. For the complete list of librairies as well as details about the script usage, run the `help` command: ```bash -$ cd $CUDF_HOME -$./build.sh --help +$ ./build.sh --help ``` ### Install and Test cuDF for contributors From 1ea8cdbd3e0a93db9a2b9f23b97553c1779f3d03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Fri, 13 Aug 2021 11:56:26 +0100 Subject: [PATCH 10/28] update other libraries paragraph in build-from-source section Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dcb50892498..aaa10e8f609 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,7 +106,7 @@ cd $CUDF_HOME ./build.sh libcudf # libcudf only ./build.sh libcudf cudf # libcudf and cudf only ``` -- Many other librairies like `dask-cudf` and `cudf-kafka` can be installed with this script. For the complete list of librairies as well as details about the script usage, run the `help` command: +- Other libraries like `cudf-kafka` and `custreamz` can be installed with this script. For the complete list of libraries as well as details about the script usage, run the `help` command: ```bash $ ./build.sh --help ``` From f8f37db5b22cf5397603e312179791e3b5d79014 Mon Sep 17 00:00:00 2001 From: iskode Date: Fri, 13 Aug 2021 17:33:52 +0000 Subject: [PATCH 11/28] emphasis on cudf_dev_cuda*.yml --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fcd2c12ba8..5a8f5ebdfca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,7 @@ conda env create --name cudf_dev --file conda/environments/cudf_dev_cuda11.0.yml # activate the environment conda activate cudf_dev ``` -- For other CUDA versions, check the corresponding `cudf_dev_cuda*.yml` file in conda/environments +- For other CUDA versions, check the corresponding cudf_dev_cuda*.yml file in conda/environments ### Build cuDF from Source From 0cd676a5f534e1f2562a8188a6bc050670345c90 Mon Sep 17 00:00:00 2001 From: iskode Date: Fri, 13 Aug 2021 18:12:02 +0000 Subject: [PATCH 12/28] add step in dask_cudf install --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c492b9e49b8..0626e7dd0c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -148,6 +148,7 @@ $ py.test -v cudf/cudf/tests # run cudf test suite - To install in edit/develop mode the `dask-cudf` python package: ```bash $ cd $CUDF_HOME/python/dask_cudf +$ python setup.py build_ext --inplace $ python setup.py develop ``` From e68ed18bb914dfc083542e62e1551b9646cbe303 Mon Sep 17 00:00:00 2001 From: iskode Date: Tue, 17 Aug 2021 07:33:30 +0000 Subject: [PATCH 13/28] add kafka and custreamz sections --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0626e7dd0c3..9cb416e4a5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,6 +158,46 @@ $ cd $CUDF_HOME/python $ py.test -v dask_cudf # run dask_cudf test suite ``` +#### Building and testing the `libcudf_kafka` C++ library + +This section provides instructions for building and testing C++ libcudf_kafka. Thus, C++ libcudf_kafka only contributor will be all set after following instructions below: + +```bash +$ cd $CUDF_HOME +$ # for C++ contributors +$./build.sh libcudf_kafka tests # building C++ cuDF and test components +$ make test # running C++ cuDF unit tests +$ # for other contributors +$./build.sh libcudf_kafka +``` + +#### Python cudf-kafka contributors: + +- To install in edit/develop mode the `cudf-kafka` python package: +```bash +$ cd $CUDF_HOME/python/cudf_kafka +$ python setup.py build_ext --inplace +$ python setup.py develop +``` + +#### Python custreamz contributors: + +- To install in edit/develop mode the `custreamz` python package: +```bash +$ cd $CUDF_HOME/python/custreamz +$ python setup.py build_ext --inplace +$ python setup.py develop +``` + +- To run `custreamz` tests : +```bash +$ cd $CUDF_HOME/python +$ py.test -v custreamz # run custreamz test suite +``` + +#### Java contributors: + +Please refer to [Java README](https://github.com/rapidsai/cudf/blob/branch-21.10/java/README.md) Done! You are ready to develop for the cuDF OSS project. But please go to [code formatting](###code-formatting) to ensure that you contributing code follows the expected format. From f7515cb5d65f39f16b3b0c663c76049788373d26 Mon Sep 17 00:00:00 2001 From: iskode Date: Tue, 17 Aug 2021 07:50:59 +0000 Subject: [PATCH 14/28] add section for each library --- CONTRIBUTING.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9cb416e4a5a..4933c205a6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,6 +130,8 @@ $./build.sh libcudf #### Building and testing the `cudf` Python library +- Requirement : `C++ libcudf` + - To build and install in edit/develop mode the `cudf` python package, in the `python/cudf` folder: ```bash $ cd $CUDF_HOME/python/cudf @@ -145,6 +147,8 @@ $ py.test -v cudf/cudf/tests # run cudf test suite #### Python dask-cudf contributors: +- Requirements : `C++ libcudf`, `Python cudf` + - To install in edit/develop mode the `dask-cudf` python package: ```bash $ cd $CUDF_HOME/python/dask_cudf @@ -161,18 +165,22 @@ $ py.test -v dask_cudf # run dask_cudf test suite #### Building and testing the `libcudf_kafka` C++ library This section provides instructions for building and testing C++ libcudf_kafka. Thus, C++ libcudf_kafka only contributor will be all set after following instructions below: - + +- Requirements : `C++ libcudf` + ```bash $ cd $CUDF_HOME $ # for C++ contributors -$./build.sh libcudf_kafka tests # building C++ cuDF and test components -$ make test # running C++ cuDF unit tests +$./build.sh libcudf_kafka tests # building C++ cudf_kafka and test components +$ make test # running C++ cudf_kafka unit tests $ # for other contributors $./build.sh libcudf_kafka ``` #### Python cudf-kafka contributors: +- Requirements : `C++ libcudf`, `C++ libcudf_kafka` + - To install in edit/develop mode the `cudf-kafka` python package: ```bash $ cd $CUDF_HOME/python/cudf_kafka @@ -182,6 +190,8 @@ $ python setup.py develop #### Python custreamz contributors: +- Requirements : `C++ libcudf`, `C++ libcudf_kafka`, `Python cudf_kafka` + - To install in edit/develop mode the `custreamz` python package: ```bash $ cd $CUDF_HOME/python/custreamz @@ -197,8 +207,11 @@ $ py.test -v custreamz # run custreamz test suite #### Java contributors: +- Requirements : `C++ libcudf` + Please refer to [Java README](https://github.com/rapidsai/cudf/blob/branch-21.10/java/README.md) + Done! You are ready to develop for the cuDF OSS project. But please go to [code formatting](###code-formatting) to ensure that you contributing code follows the expected format. ## Debugging cuDF From d3073d0fcf9c8d9bd1eeca4e4255407c976ec7ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 10:11:38 +0100 Subject: [PATCH 15/28] remove `requirements` in cudf installation Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4933c205a6e..387a34c7367 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,7 +130,7 @@ $./build.sh libcudf #### Building and testing the `cudf` Python library -- Requirement : `C++ libcudf` +- First, build the `libcudf` C++ library following the steps above - To build and install in edit/develop mode the `cudf` python package, in the `python/cudf` folder: ```bash From 7e167aef28edea93e87b2332e1f9816f4062d499 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 10:13:16 +0100 Subject: [PATCH 16/28] remove folder specification in cudf installation Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 387a34c7367..ff908b4ef78 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -132,7 +132,7 @@ $./build.sh libcudf - First, build the `libcudf` C++ library following the steps above -- To build and install in edit/develop mode the `cudf` python package, in the `python/cudf` folder: +- To build and install in edit/develop `cudf` python package in edit/develop mode: ```bash $ cd $CUDF_HOME/python/cudf $ python setup.py build_ext --inplace From 2859c1de3fb0bc13c93dd2a330a9a2a40030fab5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 10:15:51 +0100 Subject: [PATCH 17/28] remove contributor label in C++ libcudf install instructions Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff908b4ef78..ffdd500182c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,7 +117,7 @@ The general workflow for building and testing the C++ and Python components of c #### Building and testing the `libcudf` C++ library -This section provides instructions for building and testing C++ libcudf. Thus, C++ libcudf only contributor will be all set after following instructions below: +This section provides instructions for building and testing C++ libcudf. ```bash $ cd $CUDF_HOME From f804fbee50bc917cece9e674396791d0a5eb966d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 12:06:48 +0100 Subject: [PATCH 18/28] remove contributor label in dask-cudf install instructions Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffdd500182c..55b58a88fb0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,7 +145,7 @@ $ cd $CUDF_HOME/python $ py.test -v cudf/cudf/tests # run cudf test suite ``` -#### Python dask-cudf contributors: +#### Installing and testing the `dask-cudf` Python library - Requirements : `C++ libcudf`, `Python cudf` From df483bf5332707956d8d42dc801fbf78ac45f198 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 12:07:54 +0100 Subject: [PATCH 19/28] add `installing` in cudf section title Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55b58a88fb0..0fe49ec92d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -128,7 +128,7 @@ $ # for other contributors $./build.sh libcudf ``` -#### Building and testing the `cudf` Python library +#### Building, installing, and testing the `cudf` Python library - First, build the `libcudf` C++ library following the steps above From e7159b10a9e3016d97716e7b57ad099befdcea21 Mon Sep 17 00:00:00 2001 From: iskode Date: Thu, 26 Aug 2021 11:51:06 +0000 Subject: [PATCH 20/28] reformulate requirement instructions in all subsections --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fe49ec92d1..943942442c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -147,7 +147,7 @@ $ py.test -v cudf/cudf/tests # run cudf test suite #### Installing and testing the `dask-cudf` Python library -- Requirements : `C++ libcudf`, `Python cudf` +- First, build the `libcudf` C++ and `cudf` Python libraries following the steps above - To install in edit/develop mode the `dask-cudf` python package: ```bash @@ -166,7 +166,7 @@ $ py.test -v dask_cudf # run dask_cudf test suite This section provides instructions for building and testing C++ libcudf_kafka. Thus, C++ libcudf_kafka only contributor will be all set after following instructions below: -- Requirements : `C++ libcudf` +- First, build the `libcudf` C++ library following the steps above ```bash $ cd $CUDF_HOME @@ -179,7 +179,7 @@ $./build.sh libcudf_kafka #### Python cudf-kafka contributors: -- Requirements : `C++ libcudf`, `C++ libcudf_kafka` +- First, build the `libcudf` and `libcudf_kafka` C++ libraries following the steps above - To install in edit/develop mode the `cudf-kafka` python package: ```bash @@ -190,7 +190,7 @@ $ python setup.py develop #### Python custreamz contributors: -- Requirements : `C++ libcudf`, `C++ libcudf_kafka`, `Python cudf_kafka` +- First, build C++ `libcudf`, C++ `libcudf_kafka`, and Python `cudf_kafka` following the steps above - To install in edit/develop mode the `custreamz` python package: ```bash @@ -207,7 +207,7 @@ $ py.test -v custreamz # run custreamz test suite #### Java contributors: -- Requirements : `C++ libcudf` +- First, build the `libcudf` C++ library following the steps above Please refer to [Java README](https://github.com/rapidsai/cudf/blob/branch-21.10/java/README.md) From 4d24281b8218f321c5894931bd9c26039576ee24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 13:42:54 +0100 Subject: [PATCH 21/28] remove language names Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 943942442c2..8ae5754fdce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -190,7 +190,7 @@ $ python setup.py develop #### Python custreamz contributors: -- First, build C++ `libcudf`, C++ `libcudf_kafka`, and Python `cudf_kafka` following the steps above +- First, build `libcudf`, `libcudf_kafka`, and `cudf_kafka` following the steps above - To install in edit/develop mode the `custreamz` python package: ```bash From f96e46e9fbd03175236c2b2d255a7e1a8fd3251c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 13:43:59 +0100 Subject: [PATCH 22/28] remove contributor label in libcudf_kafka section Co-authored-by: Ashwin Srinath <3190405+shwina@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ae5754fdce..e109061a5df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,7 +164,7 @@ $ py.test -v dask_cudf # run dask_cudf test suite #### Building and testing the `libcudf_kafka` C++ library -This section provides instructions for building and testing C++ libcudf_kafka. Thus, C++ libcudf_kafka only contributor will be all set after following instructions below: +This section provides instructions for building and testing C++ libcudf_kafka. - First, build the `libcudf` C++ library following the steps above From 793867a3ffac02bdbf6455566f9cd500ae9d2095 Mon Sep 17 00:00:00 2001 From: iskode Date: Thu, 26 Aug 2021 13:06:41 +0000 Subject: [PATCH 23/28] reorganize C++ libraries' instructions --- CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e109061a5df..dd9e4185526 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,15 +117,21 @@ The general workflow for building and testing the C++ and Python components of c #### Building and testing the `libcudf` C++ library -This section provides instructions for building and testing C++ libcudf. +If you're only interested in building the library (and not the unit tests): ```bash $ cd $CUDF_HOME -$ # for C++ contributors -$./build.sh libcudf tests # building C++ cuDF and test components -$ make test # running C++ cuDF unit tests -$ # for other contributors -$./build.sh libcudf +$./build.sh libcudf +``` +If, in addition, you want to build tests: + +```bash +$./build.sh libcudf tests +``` +To run the tests: + +```bash +$ make test ``` #### Building, installing, and testing the `cudf` Python library @@ -142,7 +148,7 @@ $ python setup.py develop - To run `cudf` tests : ```bash $ cd $CUDF_HOME/python -$ py.test -v cudf/cudf/tests # run cudf test suite +$ py.test -v cudf/cudf/tests ``` #### Installing and testing the `dask-cudf` Python library @@ -159,22 +165,26 @@ $ python setup.py develop - To run `dask_cudf` tests : ```bash $ cd $CUDF_HOME/python -$ py.test -v dask_cudf # run dask_cudf test suite +$ py.test -v dask_cudf ``` #### Building and testing the `libcudf_kafka` C++ library -This section provides instructions for building and testing C++ libcudf_kafka. +If you're only interested in building the library (and not the unit tests): + +```bash +$ cd $CUDF_HOME +$./build.sh libcudf_kafka +``` +If, in addition, you want to build tests: -- First, build the `libcudf` C++ library following the steps above +```bash +$./build.sh libcudf_kafka tests +``` +To run the tests: ```bash -$ cd $CUDF_HOME -$ # for C++ contributors -$./build.sh libcudf_kafka tests # building C++ cudf_kafka and test components -$ make test # running C++ cudf_kafka unit tests -$ # for other contributors -$./build.sh libcudf_kafka +$ make test ``` #### Python cudf-kafka contributors: @@ -202,14 +212,14 @@ $ python setup.py develop - To run `custreamz` tests : ```bash $ cd $CUDF_HOME/python -$ py.test -v custreamz # run custreamz test suite +$ py.test -v custreamz ``` #### Java contributors: - First, build the `libcudf` C++ library following the steps above -Please refer to [Java README](https://github.com/rapidsai/cudf/blob/branch-21.10/java/README.md) +- Then, refer to [Java README](https://github.com/rapidsai/cudf/blob/branch-21.10/java/README.md) Done! You are ready to develop for the cuDF OSS project. But please go to [code formatting](###code-formatting) to ensure that you contributing code follows the expected format. From 98de65aa685f4501d7505baabb41376b7601c6e0 Mon Sep 17 00:00:00 2001 From: iskode Date: Thu, 26 Aug 2021 13:30:11 +0000 Subject: [PATCH 24/28] refactor subsection titles and remove redundant words --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd9e4185526..42c2b7277e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,11 +111,11 @@ cd $CUDF_HOME $ ./build.sh --help ``` -### Install and Test cuDF for contributors +### Build, Install and Test cuDF libraries for contributors -The general workflow for building and testing the C++ and Python components of cuDF are provided below. Please also see the last section about [code formatting](###code-formatting). +The general workflow is provided below. Please, also see the last section about [code formatting](###code-formatting). -#### Building and testing the `libcudf` C++ library +#### `libcudf` (C++) If you're only interested in building the library (and not the unit tests): @@ -134,7 +134,7 @@ To run the tests: $ make test ``` -#### Building, installing, and testing the `cudf` Python library +#### `cudf` (Python) - First, build the `libcudf` C++ library following the steps above @@ -151,7 +151,7 @@ $ cd $CUDF_HOME/python $ py.test -v cudf/cudf/tests ``` -#### Installing and testing the `dask-cudf` Python library +#### `dask-cudf` (Python) - First, build the `libcudf` C++ and `cudf` Python libraries following the steps above @@ -168,7 +168,7 @@ $ cd $CUDF_HOME/python $ py.test -v dask_cudf ``` -#### Building and testing the `libcudf_kafka` C++ library +#### `libcudf_kafka` (C++) If you're only interested in building the library (and not the unit tests): @@ -187,9 +187,9 @@ To run the tests: $ make test ``` -#### Python cudf-kafka contributors: +#### `cudf-kafka` (Python) -- First, build the `libcudf` and `libcudf_kafka` C++ libraries following the steps above +- First, build the `libcudf` and `libcudf_kafka` following the steps above - To install in edit/develop mode the `cudf-kafka` python package: ```bash @@ -198,7 +198,7 @@ $ python setup.py build_ext --inplace $ python setup.py develop ``` -#### Python custreamz contributors: +#### `custreamz` (Python) - First, build `libcudf`, `libcudf_kafka`, and `cudf_kafka` following the steps above @@ -215,7 +215,7 @@ $ cd $CUDF_HOME/python $ py.test -v custreamz ``` -#### Java contributors: +#### `cudf` (Java): - First, build the `libcudf` C++ library following the steps above From dd93ade4be17188fc90e28557ea377b1d886cd95 Mon Sep 17 00:00:00 2001 From: iskode Date: Thu, 26 Aug 2021 13:32:33 +0000 Subject: [PATCH 25/28] fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42c2b7277e9..4000dd6b658 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -138,7 +138,7 @@ $ make test - First, build the `libcudf` C++ library following the steps above -- To build and install in edit/develop `cudf` python package in edit/develop mode: +- To build and install in edit/develop `cudf` python package: ```bash $ cd $CUDF_HOME/python/cudf $ python setup.py build_ext --inplace From f792bf281214cb108b52a88931bb882a040ef472 Mon Sep 17 00:00:00 2001 From: iskode Date: Thu, 26 Aug 2021 16:51:49 +0000 Subject: [PATCH 26/28] remove $ in all bash codes --- CONTRIBUTING.md | 60 ++++++++++++++++++++++++------------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4000dd6b658..d42a65f6b72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,7 +108,7 @@ cd $CUDF_HOME ``` - Other libraries like `cudf-kafka` and `custreamz` can be installed with this script. For the complete list of libraries as well as details about the script usage, run the `help` command: ```bash -$ ./build.sh --help +./build.sh --help ``` ### Build, Install and Test cuDF libraries for contributors @@ -120,18 +120,18 @@ The general workflow is provided below. Please, also see the last section about If you're only interested in building the library (and not the unit tests): ```bash -$ cd $CUDF_HOME -$./build.sh libcudf +cd $CUDF_HOME +./build.sh libcudf ``` If, in addition, you want to build tests: ```bash -$./build.sh libcudf tests +./build.sh libcudf tests ``` To run the tests: ```bash -$ make test +make test ``` #### `cudf` (Python) @@ -140,15 +140,15 @@ $ make test - To build and install in edit/develop `cudf` python package: ```bash -$ cd $CUDF_HOME/python/cudf -$ python setup.py build_ext --inplace -$ python setup.py develop +cd $CUDF_HOME/python/cudf +python setup.py build_ext --inplace +python setup.py develop ``` - To run `cudf` tests : ```bash -$ cd $CUDF_HOME/python -$ py.test -v cudf/cudf/tests +cd $CUDF_HOME/python +py.test -v cudf/cudf/tests ``` #### `dask-cudf` (Python) @@ -157,15 +157,15 @@ $ py.test -v cudf/cudf/tests - To install in edit/develop mode the `dask-cudf` python package: ```bash -$ cd $CUDF_HOME/python/dask_cudf -$ python setup.py build_ext --inplace -$ python setup.py develop +cd $CUDF_HOME/python/dask_cudf +python setup.py build_ext --inplace +python setup.py develop ``` - To run `dask_cudf` tests : ```bash -$ cd $CUDF_HOME/python -$ py.test -v dask_cudf +cd $CUDF_HOME/python +py.test -v dask_cudf ``` #### `libcudf_kafka` (C++) @@ -173,18 +173,18 @@ $ py.test -v dask_cudf If you're only interested in building the library (and not the unit tests): ```bash -$ cd $CUDF_HOME -$./build.sh libcudf_kafka +cd $CUDF_HOME +./build.sh libcudf_kafka ``` If, in addition, you want to build tests: ```bash -$./build.sh libcudf_kafka tests +./build.sh libcudf_kafka tests ``` To run the tests: ```bash -$ make test +make test ``` #### `cudf-kafka` (Python) @@ -193,9 +193,9 @@ $ make test - To install in edit/develop mode the `cudf-kafka` python package: ```bash -$ cd $CUDF_HOME/python/cudf_kafka -$ python setup.py build_ext --inplace -$ python setup.py develop +cd $CUDF_HOME/python/cudf_kafka +python setup.py build_ext --inplace +python setup.py develop ``` #### `custreamz` (Python) @@ -204,15 +204,15 @@ $ python setup.py develop - To install in edit/develop mode the `custreamz` python package: ```bash -$ cd $CUDF_HOME/python/custreamz -$ python setup.py build_ext --inplace -$ python setup.py develop +cd $CUDF_HOME/python/custreamz +python setup.py build_ext --inplace +python setup.py develop ``` - To run `custreamz` tests : ```bash -$ cd $CUDF_HOME/python -$ py.test -v custreamz +cd $CUDF_HOME/python +py.test -v custreamz ``` #### `cudf` (Java): @@ -232,7 +232,7 @@ Follow the [above instructions](####build-cudf-from-source) to build from source For example: ```bash -$ ./build.sh libcudf -g +./build.sh libcudf -g ``` This builds `libcudf` in Debug mode which enables some `assert` safety checks and includes symbols in the library for debugging. @@ -291,11 +291,11 @@ A Dockerfile is provided with a preconfigured conda environment for building and From cudf project root run the following, to build with defaults: ```bash -$ docker build --tag cudf . +docker build --tag cudf . ``` After the container is built run the container: ```bash -$ docker run --runtime=nvidia -it cudf bash +docker run --runtime=nvidia -it cudf bash ``` Activate the conda environment `cudf` to use the newly built cuDF and libcudf libraries: ``` From 7a628ac1c1dbb0dabb60edd551ea39caade8e682 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 21:28:25 +0100 Subject: [PATCH 27/28] correct cases Co-authored-by: Robert Maynard --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d42a65f6b72..01ed09bc395 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,7 +111,7 @@ cd $CUDF_HOME ./build.sh --help ``` -### Build, Install and Test cuDF libraries for contributors +### Build, install and test cuDF libraries for contributors The general workflow is provided below. Please, also see the last section about [code formatting](###code-formatting). From 970611808c4eaf8524b4f349a5c9f72fe1678804 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Kon=C3=A9?= Date: Thu, 26 Aug 2021 21:29:52 +0100 Subject: [PATCH 28/28] correct cases Co-authored-by: Robert Maynard --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01ed09bc395..f83d7c5b759 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,7 +92,7 @@ conda activate cudf_dev ``` - For other CUDA versions, check the corresponding cudf_dev_cuda*.yml file in conda/environments -### Build cuDF from Source +### Build cuDF from source - A `build.sh` script is provided in `$CUDF_HOME`. Running the script with no additional arguments will install the `libcudf`, `cudf` and `dask_cudf` libraries. By default, the libraries are installed to the `$CONDA_PREFIX` directory. To install into a different location, set the location in `$INSTALL_PREFIX`. Finally, note that the script depends on the `nvcc` executable being on your path, or defined in `$CUDACXX`. ```bash