cuml-cu12 23.12.0__tar.gz → 24.4.0__tar.gz

PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.1
+Name: cuml-cu12
+Version: 24.4.0
+Summary: cuML - RAPIDS ML Algorithms
+Author: NVIDIA Corporation
+License: Apache 2.0
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Project-URL: Homepage, https://github.com/rapidsai/cuml
+Project-URL: Documentation, https://docs.rapids.ai/api/cuml/stable/
+Requires-Python: >=3.9
+Provides-Extra: test
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Stub-Only: True
+
+# cuML Python Package
+
+This folder contains the Python and Cython code of the algorithms and ML primitives of cuML, that are distributed in the Python cuML package.
+
+Contents:
+
+- [cuML Python Package](#cuml-python-package)
+    - [Build Configuration](#build-configuration)
+    - [RAFT Integration in cuml.raft](#raft-integration-in-cumlraft)
+    - [Build Requirements](#build-requirements)
+    - [Python Tests](#python-tests)
+
+### Build Configuration
+
+The build system uses setup.py for configuration and building.
+
+cuML's setup.py can be configured through environment variables and command line arguments.
+
+The environment variables are:
+
+| Environment variable | Possible values | Default behavior if not set | Behavior |
+| --- | --- | --- | --- |
+| CUDA_HOME | path/to/cuda_toolkit | Inferred by location of `nvcc` | Optional variable allowing to manually specify location of the CUDA toolkit. |
+| CUML_BUILD_PATH | path/to/libcuml_build_folder | Looked for in path_to_cuml_repo/cpp/build | Optional variable allowing to manually specify location of libcuml++ build folder. |
+| RAFT_PATH | path/to/raft |  Looked for in path_to_cuml_repo/cpp/build, if not found clone  | Optional variable allowing to manually specify location of the RAFT Repository. |
+
+The command line arguments (i.e. passed alongside `setup.py` when invoking, for
+example `setup.py --singlegpu`) are:
+
+
+| Argument | Behavior |
+| --- | --- |
+| clean --all | Cleans all Python and Cython artifacts, including pycache folders, .cpp files resulting of cythonization and compiled extensions. |
+| --singlegpu | Option to build cuML without multiGPU algorithms. Removes dependency on nccl, libcumlprims and ucx-py. |
+
+
+### RAFT Integration in cuml.raft
+
+RAFT's Python and Cython is located in the [RAFT repository](https://github.com/rapidsai/raft/python). It was designed to be included in projects as opposed to be distributed by itself, so at build time, **setup.py creates a symlink from cuML, located in `/python/cuml/raft/` to the Python folder of RAFT**.
+
+For developers that need to modify RAFT code, please refer to the [RAFT Developer Guide](https://github.com/rapidsai/raft/blob/branch-24.04/docs/source/build.md) for recommendations.
+
+To configure RAFT at build time:
+
+1. If the environment variable `RAFT_PATH` points to the RAFT repo, then that will be used.
+2. If there is a libcuml build folder that has cloned RAFT already, setup.py will use that RAFT. Location of this can be configured with the environment variable CUML_BUILD_PATH.
+3. If none of the above happened, then setup.py will clone RAFT and use it directly.
+
+The RAFT Python code gets included in the cuML build and distributable artifacts as if it was always present in the folder structure of cuML.
+
+### Build Requirements
+
+cuML's convenience [development yaml files](https://github.com/rapidsai/cuml/tree/branch-24.04/environments) includes all dependencies required to build cuML.
+
+To build cuML's Python package, the following dependencies are required:
+
+- cudatoolkit version corresponding to system CUDA toolkit
+- setuptools
+- cython >= 0.29, < 0.30
+- numpy
+- cmake >= 3.14
+- cudf version matching the cuML version
+- libcuml version matching the cuML version
+- libcuml={{ version }}
+- cupy>=7.8.0,<12.0.0a0
+- joblib >=0.11
+
+Packages required for multigpu algorithms*:
+- libcumlprims version matching the cuML version
+- ucx-py version matching the cuML version
+- dask-cudf version matching the cuML version
+- nccl>=2.5
+- rapids-dask-dependency version matching the cuML version
+
+* this can be avoided with `--singlegpu` argument flag.
+
+
+### Python Tests
+
+Python tests are based on the pytest library. To run them, from the `path_to_cuml/python/` folder, simply type `pytest`.
+
+

pyproject.toml

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2
+
+[build-system]
+requires = ["nvidia-stub"]
+build-backend = "nvidia_stub.buildapi"

cuml-cu12-23.12.0/ERROR.txt

@@ -1,10 +0,0 @@
-
-###########################################################################################
-The package you are trying to install is only a placeholder project on PyPI.org repository.
-This package is hosted on NVIDIA Python Package Index.
-
-This package can be installed as:
-```
-$ pip install --no-cache-dir --extra-index-url https://pypi.nvidia.com cuml-cu12
-```
-###########################################################################################

cuml-cu12-23.12.0/LICENSE.md

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2020 NVIDIA
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

cuml-cu12-23.12.0/PACKAGE_NAME

@@ -1 +0,0 @@
-cuml-cu12

cuml-cu12-23.12.0/PKG-INFO

@@ -1,41 +0,0 @@
-Metadata-Version: 2.1
-Name: cuml-cu12
-Version: 23.12.0
-Summary: A fake package to warn the user they are not installing the correct package.
-Home-page: https://github.com/NVIDIA
-Download-URL: https://github.com/NVIDIA
-Author: Kitmaker
-Author-email: kitmaker@nvidia.com
-Maintainer: Kitmaker
-Maintainer-email: kitmaker@nvidia.com
-License: Apache2
-Keywords: nvidia,deep learning,machine learning,supervised learning,unsupervised learning,reinforcement learning,logging
-Platform: Linux
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: Information Technology
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Image Recognition
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Utilities
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Environment :: Console
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-License-File: LICENSE.md
-
-CUML-CU12
-=========
-
-**WARNING:** This project is not functional and is a placeholder from NVIDIA.
-To install, please execute the following:
-
-.. code-block:: bash
-
-    pip install --no-cache-dir --extra-index-url https://pypi.nvidia.com cuml-cu12

cuml-cu12-23.12.0/README.rst

@@ -1,9 +0,0 @@
-CUML-CU12
-=========
-
-**WARNING:** This project is not functional and is a placeholder from NVIDIA.
-To install, please execute the following:
-
-.. code-block:: bash
-
-    pip install --no-cache-dir --extra-index-url https://pypi.nvidia.com cuml-cu12

cuml-cu12-23.12.0/cuml_cu12.egg-info/PKG-INFO

@@ -1,41 +0,0 @@
-Metadata-Version: 2.1
-Name: cuml-cu12
-Version: 23.12.0
-Summary: A fake package to warn the user they are not installing the correct package.
-Home-page: https://github.com/NVIDIA
-Download-URL: https://github.com/NVIDIA
-Author: Kitmaker
-Author-email: kitmaker@nvidia.com
-Maintainer: Kitmaker
-Maintainer-email: kitmaker@nvidia.com
-License: Apache2
-Keywords: nvidia,deep learning,machine learning,supervised learning,unsupervised learning,reinforcement learning,logging
-Platform: Linux
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: Information Technology
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Image Recognition
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Utilities
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Environment :: Console
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-License-File: LICENSE.md
-
-CUML-CU12
-=========
-
-**WARNING:** This project is not functional and is a placeholder from NVIDIA.
-To install, please execute the following:
-
-.. code-block:: bash
-
-    pip install --no-cache-dir --extra-index-url https://pypi.nvidia.com cuml-cu12

cuml-cu12-23.12.0/cuml_cu12.egg-info/SOURCES.txt

@@ -1,9 +0,0 @@
-ERROR.txt
-LICENSE.md
-PACKAGE_NAME
-README.rst
-setup.py
-cuml_cu12.egg-info/PKG-INFO
-cuml_cu12.egg-info/SOURCES.txt
-cuml_cu12.egg-info/dependency_links.txt
-cuml_cu12.egg-info/top_level.txt

cuml-cu12-23.12.0/cuml_cu12.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

cuml-cu12-23.12.0/cuml_cu12.egg-info/top_level.txt

@@ -1 +0,0 @@
-printWheelNameVersion

cuml-cu12-23.12.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

cuml-cu12-23.12.0/setup.py

@@ -1,137 +0,0 @@
-#! /usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import os
-import sys
-import codecs
-import fileinput
-import shutil
-
-from contextlib import contextmanager
-
-from setuptools import setup
-
-# Get the long description
-BASE_DIR = os.path.abspath(os.path.dirname(__file__))
-
-
-def build_package(pkg_name, pkg_version):
-
-    with codecs.open(os.path.join(BASE_DIR, 'README.rst'), encoding='utf-8') as f:
-        long_description = f.read()
-
-    setup(
-        name=pkg_name,
-        version=pkg_version,
-        description="A fake package to warn the user they are not installing the correct package.",
-        long_description=long_description,
-
-        # The project's main homepage.
-        url='https://github.com/NVIDIA',
-        download_url='https://github.com/NVIDIA',
-
-        # Author details
-        author="Kitmaker",
-        author_email='kitmaker@nvidia.com',
-
-        # maintainer Details
-        maintainer='Kitmaker',
-        maintainer_email='kitmaker@nvidia.com',
-
-        # The licence under which the project is released
-        license='Apache2',
-        classifiers=[
-            'Development Status :: 3 - Alpha',
-            'Intended Audience :: Developers',
-            'Intended Audience :: Science/Research',
-            'Intended Audience :: Information Technology',
-            'Topic :: Scientific/Engineering',
-            'Topic :: Scientific/Engineering :: Image Recognition',
-            'Topic :: Scientific/Engineering :: Artificial Intelligence',
-            'Topic :: Software Development :: Libraries',
-            'Topic :: Utilities',
-            'License :: OSI Approved :: Apache Software License',
-            'Programming Language :: Python :: 3.5',
-            'Programming Language :: Python :: 3.6',
-            'Programming Language :: Python :: 3.7',
-            'Programming Language :: Python :: 3.8',
-            'Environment :: Console',
-            'Natural Language :: English',
-            'Operating System :: OS Independent',
-        ],
-        platforms=["Linux"],
-        keywords='nvidia, deep learning, machine learning, supervised learning, unsupervised learning, reinforcement learning, logging',
-    )
-
-if len(sys.argv) != 4:
-    raise RuntimeError("Bad params")
-
-action=sys.argv[1]
-package_name=sys.argv[2]
-package_version=sys.argv[3]
-
-# Need to remove the custom options or distutils will get sad
-sys.argv.remove(package_name)
-sys.argv.remove(package_version)
-
-if action == "sdist":
-
-    def maybe_delete_file(filename):
-        try:
-            os.remove(filename)
-        except FileNotFoundError:
-            pass
-
-    @contextmanager
-    def setup_sdist_environment(package_name):
-
-        temporary_files = ["README.rst", "ERROR.txt", "PACKAGE_NAME"]
-        for file in temporary_files:
-            maybe_delete_file(file)
-
-        with open("PACKAGE_NAME", "w") as f:
-            f.write(package_name)
-
-        shutil.copyfile("README.rst.in", "README.rst")
-        shutil.copyfile("ERROR.txt.in", "ERROR.txt")
-
-        def replace_in_file(search_text, new_text, filename):
-            with fileinput.input(filename, inplace=True) as f:
-                for line in f:
-                    new_line = line.replace(search_text, new_text)
-                    print(new_line, end='')
-
-        replace_in_file("<PACKAGE_NAME>", package_name.upper(), filename="README.rst")
-        replace_in_file("==============", "=" * len(package_name), filename="README.rst")
-
-        replace_in_file("<package_name>", package_name, filename="README.rst")
-        replace_in_file("<package_name>", package_name, filename="ERROR.txt")
-
-        yield
-
-        for file in temporary_files:
-            maybe_delete_file(file)
-
-        shutil.rmtree("%s.egg-info" % package_name.replace("-", "_"))
-
-    print(f"\n[*] Building {package_name} ...")
-
-    with setup_sdist_environment(package_name):
-        build_package(package_name, package_version)
-
-else:
-    raise RuntimeError(open("ERROR.txt", "r").read())