This is an automated email from the ASF dual-hosted git repository.
tlopex pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tvm.git
The following commit(s) were added to refs/heads/main by this push:
new 1ebd5e060e [DOC] Fix docstring, unify CMake, nvidia-docker deprecation
(#18799)
1ebd5e060e is described below
commit 1ebd5e060ef3b2c0fd439e431c37f96711d904cf
Author: Ruslan Baratov <[email protected]>
AuthorDate: Fri Feb 20 04:01:27 2026 +0800
[DOC] Fix docstring, unify CMake, nvidia-docker deprecation (#18799)
- Fix docstring in transform.py
- Unify CMake naming
- nvidia-docker is deprecated
---
CMakeLists.txt | 6 ++---
Makefile | 4 ++--
apps/cpp_rpc/CMakeLists.txt | 2 +-
apps/cpp_rpc/README.md | 10 ++++----
apps/hexagon_api/README.md | 2 +-
apps/hexagon_launcher/README.md | 2 +-
apps/hexagon_launcher/cmake/HexagonLauncher.cmake | 2 +-
apps/ios_rpc/CMakeLists.txt | 2 +-
apps/ios_rpc/README.md | 2 +-
ci/jenkins/generated/arm_jenkinsfile.groovy | 4 ++--
ci/jenkins/generated/cpu_jenkinsfile.groovy | 4 ++--
ci/jenkins/generated/docker_jenkinsfile.groovy | 2 +-
ci/jenkins/generated/gpu_jenkinsfile.groovy | 2 +-
ci/jenkins/generated/lint_jenkinsfile.groovy | 2 +-
ci/jenkins/generated/wasm_jenkinsfile.groovy | 4 ++--
ci/jenkins/templates/arm_jenkinsfile.groovy.j2 | 2 +-
ci/jenkins/templates/cpu_jenkinsfile.groovy.j2 | 2 +-
ci/jenkins/templates/utils/Build.groovy.j2 | 2 +-
ci/jenkins/templates/wasm_jenkinsfile.groovy.j2 | 2 +-
cmake/config.cmake | 28 +++++++++++------------
cmake/libs/Libbacktrace.cmake | 2 +-
cmake/modules/CUDA.cmake | 6 ++---
cmake/modules/ClangFlags.cmake | 2 +-
cmake/modules/ROCM.cmake | 2 +-
cmake/modules/contrib/ArmComputeLib.cmake | 2 +-
cmake/modules/contrib/CLML.cmake | 2 +-
cmake/utils/Utils.cmake | 6 ++---
docker/bash.sh | 2 +-
docker/install/ubuntu_install_python.sh | 2 +-
docs/install/docker.rst | 3 ++-
docs/install/from_source.rst | 2 +-
python/tvm/libinfo.py | 2 +-
python/tvm/relax/transform/transform.py | 1 +
src/contrib/msc/plugin/base_codegen.h | 6 ++---
src/contrib/msc/plugin/tensorrt_codegen.h | 2 +-
src/contrib/msc/plugin/torch_codegen.h | 2 +-
src/contrib/msc/plugin/tvm_codegen.h | 2 +-
src/runtime/hexagon/README.md | 6 ++---
src/support/libinfo.cc | 2 +-
src/target/datatype/posit/posit-wrapper.cc | 2 +-
40 files changed, 72 insertions(+), 70 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 690dab0c62..116fb1a55c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -169,7 +169,7 @@ if(MSVC)
string(REGEX REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}")
endif(${flag_var} MATCHES "/MD")
endforeach(flag_var)
- # Static linking. cmake behavior changed in 3.15 making this necessary.
+ # Static linking. CMake behavior changed in 3.15 making this necessary.
add_compile_options(/MT)
endif()
# Disable common MSVC warnings
@@ -388,8 +388,8 @@ endif()
# Enable ctest if gtest is available
if(USE_GTEST)
# Check env var for backward compatibility. A better way to specify package
- # locations is to use CMAKE_PREFIX_PATH or other standard cmake mechanism
- # (see cmake documentation for `find_package`).
+ # locations is to use CMAKE_PREFIX_PATH or other standard CMake mechanism
+ # (see CMake documentation for `find_package`).
set(GTEST_ROOT "$ENV{GTEST_LIB}")
if("${USE_GTEST}" STREQUAL "AUTO")
# If USE_GTEST is AUTO, treat GTest as optional: enable if found.
diff --git a/Makefile b/Makefile
index b22a3ff2fb..e755976c95 100644
--- a/Makefile
+++ b/Makefile
@@ -60,7 +60,7 @@ endif
# Cannot use .PHONY with a pattern rule, using FORCE instead. For
-# now, force cmake to be re-run with each compile to mimic previous
+# now, force CMake to be re-run with each compile to mimic previous
# behavior. This may be relaxed in the future with the
# CONFIGURE_DEPENDS option for GLOB (requires cmake >= 3.12).
FORCE:
@@ -69,7 +69,7 @@ FORCE:
# Since the pattern stem is already being used for the directory name,
-# cannot also have it refer to the command passed to cmake.
+# cannot also have it refer to the command passed to CMake.
# Therefore, explicitly listing out the delegated.
CMAKE_TARGETS = all runtime cpptest crttest clean
diff --git a/apps/cpp_rpc/CMakeLists.txt b/apps/cpp_rpc/CMakeLists.txt
index f3ce31d759..b65d66b560 100644
--- a/apps/cpp_rpc/CMakeLists.txt
+++ b/apps/cpp_rpc/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_policy(SET CMP0069 NEW) # suppress cmake warning about IPO
+cmake_policy(SET CMP0069 NEW) # suppress CMake warning about IPO
set(TVM_RPC_SOURCES
main.cc
diff --git a/apps/cpp_rpc/README.md b/apps/cpp_rpc/README.md
index 58eb68055f..2c6111ac3c 100644
--- a/apps/cpp_rpc/README.md
+++ b/apps/cpp_rpc/README.md
@@ -19,18 +19,18 @@
This folder contains a simple recipe to make RPC server in c++.
## Usage (Non-Windows)
-- Configure the tvm cmake build with `config.cmake` ensuring that
`USE_CPP_RPC` is set to `ON` in the config.
-- If cross compiling for Android, add the following options to the cmake
config or specify them when invoking cmake:
+- Configure the tvm CMake build with `config.cmake` ensuring that
`USE_CPP_RPC` is set to `ON` in the config.
+- If cross compiling for Android, add the following options to the CMake
config or specify them when invoking CMake:
```
# Whether to build the C++ RPC server binary
set(USE_CPP_RPC ON)
- # Path to the Android NDK cmake toolchain
+ # Path to the Android NDK CMake toolchain
set(CMAKE_TOOLCHAIN_FILE
$ENV{ANDROID_NDK}/build/cmake/android.toolchain.cmake)
# The Android ABI and platform to target
set(ANDROID_ABI "arm64-v8a")
set(ANDROID_PLATFORM android-28)
```
-- Similarly, if cross compiling for embedded Linux add the following options
to cmake config:
+- Similarly, if cross compiling for embedded Linux add the following options
to CMake config:
```
# Needed to ensure pthread is linked
set(OS Linux)
@@ -58,7 +58,7 @@ This folder contains a simple recipe to make RPC server in
c++.
- Use `./tvm_rpc server` to start the RPC server
## Usage (Windows)
-- Configure the tvm cmake build with `config.cmake` ensuring that
`USE_CPP_RPC` is set to `ON` in the config.
+- Configure the tvm CMake build with `config.cmake` ensuring that
`USE_CPP_RPC` is set to `ON` in the config.
- Install [LLVM pre-build binaries](https://releases.llvm.org/download.html),
making sure to select the option to add it to the PATH.
- Verify Python 3.6 or newer is installed and in the PATH.
- Use `<tvm_output_dir>\tvm_rpc.exe` to start the RPC server
diff --git a/apps/hexagon_api/README.md b/apps/hexagon_api/README.md
index cddb3e90d6..f8f5f792af 100644
--- a/apps/hexagon_api/README.md
+++ b/apps/hexagon_api/README.md
@@ -26,7 +26,7 @@ Hexagon built into it.
## Configuration
-There is a set of configuration variables that are required for cmake:
+There is a set of configuration variables that are required for CMake:
- `ANDROID_ABI`: Set this to `arm64-v8a`.
- `ANDROID_PLATFORM`: This can be `android-28`.
- `USE_ANDROID_TOOLCHAIN`: The path to the Android toolchain file, i.e.
diff --git a/apps/hexagon_launcher/README.md b/apps/hexagon_launcher/README.md
index 706313c6d2..0cee1de4c9 100644
--- a/apps/hexagon_launcher/README.md
+++ b/apps/hexagon_launcher/README.md
@@ -68,7 +68,7 @@ cmake
-DCMAKE_TOOLCHAIN_FILE=/path/to/android-ndk/build/cmake/android.toolchain.
```
Run `make`. This will create `launcher_android`. The TVM runtime for Android
will
-be built as a part of the process. Depending on the version of cmake that you
are
+be built as a part of the process. Depending on the version of CMake that you
are
using, you may see the following warnings---they can be ignored.
```
diff --git a/apps/hexagon_launcher/cmake/HexagonLauncher.cmake
b/apps/hexagon_launcher/cmake/HexagonLauncher.cmake
index 3d3ce0c771..52e2cff1f8 100644
--- a/apps/hexagon_launcher/cmake/HexagonLauncher.cmake
+++ b/apps/hexagon_launcher/cmake/HexagonLauncher.cmake
@@ -61,7 +61,7 @@ set(CMAKE_SKIP_RPATH TRUE)
# Qaic for the domain header.
#
-# Don't add paths to these filenames, or otherwise cmake may spontaneously
+# Don't add paths to these filenames, or otherwise CMake may spontaneously
# add -o option to the qaic invocation (with an undesirable path).
set(LAUNCHER_RPC_IDL "launcher_rpc.idl")
set(LAUNCHER_RPC_H "launcher_rpc.h")
diff --git a/apps/ios_rpc/CMakeLists.txt b/apps/ios_rpc/CMakeLists.txt
index 0ced6fb0c6..ea00c53b04 100644
--- a/apps/ios_rpc/CMakeLists.txt
+++ b/apps/ios_rpc/CMakeLists.txt
@@ -57,7 +57,7 @@ if(NOT CMAKE_IOS_RPC_BUNDLE)
set(CMAKE_IOS_RPC_BUNDLE org.apache.tvmrpc)
endif()
-# iOS RPC Xcode project wrapper to integrate into Cmake
+# iOS RPC Xcode project wrapper to integrate into CMake
ExternalProject_Add(ios_rpc
PREFIX ios_rpc
DEPENDS custom_dso_loader tvm_runtime
diff --git a/apps/ios_rpc/README.md b/apps/ios_rpc/README.md
index 2d9cc52dc0..b4db252e91 100644
--- a/apps/ios_rpc/README.md
+++ b/apps/ios_rpc/README.md
@@ -43,7 +43,7 @@ mechanic is integrated into TVM RPC as plugin and registered
to execution only
inside iOS RPC application.
The custom implementation of `dlopen` and other functions from `dlfcn.h`
header are placed in separate repository,
-and will be downloaded automatically during cmake build for iOS.
+and will be downloaded automatically during CMake build for iOS.
Also, it is necessary to build `libtvm_runtime.dylib` for our iOS device. The
iOS TVM RPC application will be linked with this library.
diff --git a/ci/jenkins/generated/arm_jenkinsfile.groovy
b/ci/jenkins/generated/arm_jenkinsfile.groovy
index 6309d6d477..17bddc9b2c 100644
--- a/ci/jenkins/generated/arm_jenkinsfile.groovy
+++ b/ci/jenkins/generated/arm_jenkinsfile.groovy
@@ -460,7 +460,7 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
def cpp_unittest(image) {
@@ -491,7 +491,7 @@ def run_build(node_type) {
], {
sh (
script: "${docker_run} ${ci_arm}
./tests/scripts/task_config_build_arm.sh build",
- label: 'Create ARM cmake config',
+ label: 'Create ARM CMake config',
)
cmake_build(ci_arm, 'build')
make_cpp_tests(ci_arm, 'build')
diff --git a/ci/jenkins/generated/cpu_jenkinsfile.groovy
b/ci/jenkins/generated/cpu_jenkinsfile.groovy
index 0a2f126411..fb9edab77b 100644
--- a/ci/jenkins/generated/cpu_jenkinsfile.groovy
+++ b/ci/jenkins/generated/cpu_jenkinsfile.groovy
@@ -460,7 +460,7 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
def cpp_unittest(image) {
@@ -491,7 +491,7 @@ def run_build(node_type) {
], {
sh (
script: "${docker_run} ${ci_cpu}
./tests/scripts/task_config_build_cpu.sh build",
- label: 'Create CPU cmake config',
+ label: 'Create CPU CMake config',
)
cmake_build(ci_cpu, 'build')
make_cpp_tests(ci_cpu, 'build')
diff --git a/ci/jenkins/generated/docker_jenkinsfile.groovy
b/ci/jenkins/generated/docker_jenkinsfile.groovy
index d91e5107f4..c4ec00664c 100644
--- a/ci/jenkins/generated/docker_jenkinsfile.groovy
+++ b/ci/jenkins/generated/docker_jenkinsfile.groovy
@@ -460,7 +460,7 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
def cpp_unittest(image) {
diff --git a/ci/jenkins/generated/gpu_jenkinsfile.groovy
b/ci/jenkins/generated/gpu_jenkinsfile.groovy
index cc089aa56c..45f5604727 100644
--- a/ci/jenkins/generated/gpu_jenkinsfile.groovy
+++ b/ci/jenkins/generated/gpu_jenkinsfile.groovy
@@ -460,7 +460,7 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
def cpp_unittest(image) {
diff --git a/ci/jenkins/generated/lint_jenkinsfile.groovy
b/ci/jenkins/generated/lint_jenkinsfile.groovy
index 34cd7512bf..d6a1833dee 100644
--- a/ci/jenkins/generated/lint_jenkinsfile.groovy
+++ b/ci/jenkins/generated/lint_jenkinsfile.groovy
@@ -460,7 +460,7 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
def cpp_unittest(image) {
diff --git a/ci/jenkins/generated/wasm_jenkinsfile.groovy
b/ci/jenkins/generated/wasm_jenkinsfile.groovy
index fe3502ee43..9fd958c968 100644
--- a/ci/jenkins/generated/wasm_jenkinsfile.groovy
+++ b/ci/jenkins/generated/wasm_jenkinsfile.groovy
@@ -460,7 +460,7 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
def cpp_unittest(image) {
@@ -491,7 +491,7 @@ def run_build(node_type) {
], {
sh (
script: "${docker_run} ${ci_wasm}
./tests/scripts/task_config_build_wasm.sh build",
- label: 'Create WASM cmake config',
+ label: 'Create WASM CMake config',
)
cmake_build(ci_wasm, 'build')
make_cpp_tests(ci_wasm, 'build')
diff --git a/ci/jenkins/templates/arm_jenkinsfile.groovy.j2
b/ci/jenkins/templates/arm_jenkinsfile.groovy.j2
index 0781bc92db..35aa9bf250 100644
--- a/ci/jenkins/templates/arm_jenkinsfile.groovy.j2
+++ b/ci/jenkins/templates/arm_jenkinsfile.groovy.j2
@@ -27,7 +27,7 @@
) %}
sh (
script: "${docker_run} ${ci_arm} ./tests/scripts/task_config_build_arm.sh
build",
- label: 'Create ARM cmake config',
+ label: 'Create ARM CMake config',
)
cmake_build(ci_arm, 'build')
make_cpp_tests(ci_arm, 'build')
diff --git a/ci/jenkins/templates/cpu_jenkinsfile.groovy.j2
b/ci/jenkins/templates/cpu_jenkinsfile.groovy.j2
index 50e47f9bbf..367da73ebe 100644
--- a/ci/jenkins/templates/cpu_jenkinsfile.groovy.j2
+++ b/ci/jenkins/templates/cpu_jenkinsfile.groovy.j2
@@ -27,7 +27,7 @@
) %}
sh (
script: "${docker_run} ${ci_cpu} ./tests/scripts/task_config_build_cpu.sh
build",
- label: 'Create CPU cmake config',
+ label: 'Create CPU CMake config',
)
cmake_build(ci_cpu, 'build')
make_cpp_tests(ci_cpu, 'build')
diff --git a/ci/jenkins/templates/utils/Build.groovy.j2
b/ci/jenkins/templates/utils/Build.groovy.j2
index 8e8310aea6..c20a1c5c43 100644
--- a/ci/jenkins/templates/utils/Build.groovy.j2
+++ b/ci/jenkins/templates/utils/Build.groovy.j2
@@ -29,6 +29,6 @@ def make_cpp_tests(image, build_dir) {
def cmake_build(image, path) {
sh (
script: "${docker_run} --env CI_NUM_EXECUTORS ${image}
./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod
--sccache-region us-west-2 --build-dir ${path}",
- label: 'Run cmake build',
+ label: 'Run CMake build',
)
}
diff --git a/ci/jenkins/templates/wasm_jenkinsfile.groovy.j2
b/ci/jenkins/templates/wasm_jenkinsfile.groovy.j2
index e3ef79c276..0d119f043e 100644
--- a/ci/jenkins/templates/wasm_jenkinsfile.groovy.j2
+++ b/ci/jenkins/templates/wasm_jenkinsfile.groovy.j2
@@ -27,7 +27,7 @@
) %}
sh (
script: "${docker_run} ${ci_wasm}
./tests/scripts/task_config_build_wasm.sh build",
- label: 'Create WASM cmake config',
+ label: 'Create WASM CMake config',
)
cmake_build(ci_wasm, 'build')
make_cpp_tests(ci_wasm, 'build')
diff --git a/cmake/config.cmake b/cmake/config.cmake
index ed6910b786..a9795f77ca 100644
--- a/cmake/config.cmake
+++ b/cmake/config.cmake
@@ -16,7 +16,7 @@
# under the License.
#--------------------------------------------------------------------
-# Template custom cmake configuration for compiling
+# Template custom CMake configuration for compiling
#
# This file is used to override the build options in build.
# If you want to change the configuration, please use the following
@@ -43,13 +43,13 @@
# Whether enable CUDA during compile,
#
# Possible values:
-# - ON: enable CUDA with cmake's auto search
+# - ON: enable CUDA with CMake's auto search
# - OFF: disable CUDA
# - /path/to/cuda: use specific path to CUDA toolkit
set(USE_CUDA OFF)
# Whether to enable NCCL support:
-# - ON: enable NCCL with cmake's auto search
+# - ON: enable NCCL with CMake's auto search
# - OFF: disable NCCL
# - /path/to/nccl: use specific path to nccl
set(USE_NCCL OFF)
@@ -60,20 +60,20 @@ set(USE_NCCL OFF)
set(USE_MSCCL OFF)
# Whether to enable NVTX support (must have USE_CUDA enabled):
-# - ON: enable NCCL with cmake's auto search
+# - ON: enable NCCL with CMake's auto search
# - OFF: disable NCCL
set(USE_NVTX OFF)
# Whether enable ROCM runtime
#
# Possible values:
-# - ON: enable ROCM with cmake's auto search
+# - ON: enable ROCM with CMake's auto search
# - OFF: disable ROCM
# - /path/to/rocm: use specific path to rocm
set(USE_ROCM OFF)
# Whether to enable RCCL support:
-# - ON: enable RCCL with cmake's auto search
+# - ON: enable RCCL with CMake's auto search
# - OFF: disable RCCL
# - /path/to/rccl: use specific path to rccl
set(USE_RCCL OFF)
@@ -98,7 +98,7 @@ set(USE_METAL OFF)
# Whether enable Vulkan runtime
#
# Possible values:
-# - ON: enable Vulkan with cmake's auto search
+# - ON: enable Vulkan with CMake's auto search
# - OFF: disable vulkan
# - /path/to/vulkan-sdk: use specific path to vulkan-sdk
set(USE_VULKAN OFF)
@@ -130,7 +130,7 @@ set(USE_IOS_RPC OFF)
# Requires LLVM version >= 4.0
#
# Possible values:
-# - ON: enable llvm with cmake's find search
+# - ON: enable llvm with CMake's find search
# - OFF: disable llvm, note this will disable CPU codegen
# which is needed for most cases
# - /path/to/llvm-config: enable specific LLVM when multiple llvm-dev is
available.
@@ -189,7 +189,7 @@ set(USE_OPENMP none)
set(USE_RANDOM ON)
# Possible values:
-# - ON: enable tflite with cmake's find search
+# - ON: enable tflite with CMake's find search
# - OFF: disable tflite
# - /path/to/libtensorflow-lite.a: use specific path to tensorflow lite library
set(USE_TFLITE OFF)
@@ -207,7 +207,7 @@ set(USE_FLATBUFFERS_PATH none)
set(USE_EDGETPU OFF)
# Possible values:
-# - ON: enable cuDNN with cmake's auto search in CUDA directory
+# - ON: enable cuDNN with CMake's auto search in CUDA directory
# - OFF: disable cuDNN
# - /path/to/cudnn: use specific path to cuDNN path
set(USE_CUDNN OFF)
@@ -268,7 +268,7 @@ set(USE_CLML_GRAPH_EXECUTOR OFF)
# Whether use Thrust
# Possible values:
-# - ON: enable Thrust with cmake's auto search
+# - ON: enable Thrust with CMake's auto search
# - OFF: disable Thrust
# - /path/to/cccl: use specific path to CCCL
set(USE_THRUST OFF)
@@ -344,12 +344,12 @@ set(USE_PAPI OFF)
# Whether to use GoogleTest for C++ unit tests. When enabled, the generated
# build file (e.g. Makefile) will have a target "cpptest".
# Possible values:
-# - ON: enable GoogleTest. The package `GTest` will be required for cmake
+# - ON: enable GoogleTest. The package `GTest` will be required for CMake
# to succeed.
# - OFF: disable GoogleTest.
-# - AUTO: cmake will attempt to find the GTest package, if found GTest will
+# - AUTO: CMake will attempt to find the GTest package, if found GTest will
# be enabled, otherwise it will be disabled.
-# Note that cmake will use `find_package` to find GTest. Please use cmake's
+# Note that CMake will use `find_package` to find GTest. Please use CMake's
# predefined variables to specify the path to the GTest package if needed.
set(USE_GTEST AUTO)
diff --git a/cmake/libs/Libbacktrace.cmake b/cmake/libs/Libbacktrace.cmake
index 4e62748a2c..2746c846fa 100644
--- a/cmake/libs/Libbacktrace.cmake
+++ b/cmake/libs/Libbacktrace.cmake
@@ -62,5 +62,5 @@ ExternalProject_Add_Step(project_libbacktrace checkout
DEPENDS ${LIBBACKTRACE_SRCS}
)
-# create include directory so cmake doesn't complain
+# create include directory so CMake doesn't complain
file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libbacktrace/include)
diff --git a/cmake/modules/CUDA.cmake b/cmake/modules/CUDA.cmake
index 61caf9c2fd..be0c7b3828 100644
--- a/cmake/modules/CUDA.cmake
+++ b/cmake/modules/CUDA.cmake
@@ -20,7 +20,7 @@ find_cuda(${USE_CUDA} ${USE_CUDNN})
if(CUDA_FOUND)
# always set the includedir when CUDA is available
- # avoid global retrigger of cmake
+ # avoid global retrigger of CMake
include_directories(SYSTEM ${CUDA_INCLUDE_DIRS})
endif(CUDA_FOUND)
@@ -34,7 +34,7 @@ if(USE_CUDA)
# Ensure that include directives to NVCC are in the
# `compile_commands.json`, as required by clangd.
#
- # As of cmake 3.29.5 [0], if the NVCC version is 11 or higher, cmake
+ # As of CMake 3.29.5 [0], if the NVCC version is 11 or higher, CMake
# will generate a "options-file.rsp" containing the -I flags for
# include directories, rather than providing them on the
# command-line. This setting exists to work around the short
@@ -59,7 +59,7 @@ if(USE_CUDA)
if(NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
if(CMAKE_VERSION VERSION_LESS "3.24")
- message(FATAL_ERROR "CMAKE_CUDA_ARCHITECTURES not set. Please upgrade
cmake to 3.24 to use native, or set CMAKE_CUDA_ARCHITECTURES manually")
+ message(FATAL_ERROR "CMAKE_CUDA_ARCHITECTURES not set. Please upgrade
CMake to 3.24 to use native, or set CMAKE_CUDA_ARCHITECTURES manually")
endif()
message(STATUS "CMAKE_CUDA_ARCHITECTURES not set, using native")
set(CMAKE_CUDA_ARCHITECTURES native)
diff --git a/cmake/modules/ClangFlags.cmake b/cmake/modules/ClangFlags.cmake
index 563c962720..61a88116c7 100644
--- a/cmake/modules/ClangFlags.cmake
+++ b/cmake/modules/ClangFlags.cmake
@@ -21,7 +21,7 @@ if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
EXECUTE_PROCESS(COMMAND ${CMAKE_CXX_COMPILER} --version OUTPUT_VARIABLE
clang_full_version)
string (REGEX REPLACE ".*clang version ([0-9]+\\.[0-9]+).*" "\\1"
CLANG_VERSION ${clang_full_version})
message(STATUS "CLANG_VERSION ${CLANG_VERSION}")
- # cmake 3.2 does not support VERSION_GREATER_EQUAL
+ # CMake 3.2 does not support VERSION_GREATER_EQUAL
set(CLANG_MINIMUM_VERSION 10.0)
if ((CLANG_VERSION VERSION_GREATER ${CLANG_MINIMUM_VERSION})
OR
diff --git a/cmake/modules/ROCM.cmake b/cmake/modules/ROCM.cmake
index 4d0f76d687..8c96d53aab 100644
--- a/cmake/modules/ROCM.cmake
+++ b/cmake/modules/ROCM.cmake
@@ -20,7 +20,7 @@ find_rocm(${USE_ROCM})
if(ROCM_FOUND)
# always set the includedir
- # avoid global retrigger of cmake
+ # avoid global retrigger of CMake
include_directories(SYSTEM ${ROCM_INCLUDE_DIRS})
add_definitions(-D__HIP_PLATFORM_HCC__=1)
add_definitions(-D__HIP_PLATFORM_AMD__=1)
diff --git a/cmake/modules/contrib/ArmComputeLib.cmake
b/cmake/modules/contrib/ArmComputeLib.cmake
index f9ff5f6b16..ebbc2c41ca 100644
--- a/cmake/modules/contrib/ArmComputeLib.cmake
+++ b/cmake/modules/contrib/ArmComputeLib.cmake
@@ -48,7 +48,7 @@ if(USE_ARM_COMPUTE_LIB_GRAPH_EXECUTOR)
tvm_file_glob(GLOB ACL_CONTRIB_SRC src/runtime/contrib/arm_compute_lib/*)
- # Cmake needs to find arm_compute, include and support directories
+ # CMake needs to find arm_compute, include and support directories
# in the path specified by ACL_PATH.
set(ACL_INCLUDE_DIRS ${ACL_PATH}/include ${ACL_PATH})
include_directories(${ACL_INCLUDE_DIRS})
diff --git a/cmake/modules/contrib/CLML.cmake b/cmake/modules/contrib/CLML.cmake
index 21621bf34c..a067aa9bcd 100644
--- a/cmake/modules/contrib/CLML.cmake
+++ b/cmake/modules/contrib/CLML.cmake
@@ -49,7 +49,7 @@ if(USE_CLML_GRAPH_EXECUTOR)
file(GLOB CLML_CONTRIB_SRC src/runtime/contrib/clml/*)
- # Cmake needs to find clml library, include and support directories
+ # CMake needs to find clml library, include and support directories
# in the path specified by CLML_PATH.
set(CLML_INCLUDE_DIRS ${CLML_PATH}/include ${CLML_PATH})
include_directories(${CLML_INCLUDE_DIRS})
diff --git a/cmake/utils/Utils.cmake b/cmake/utils/Utils.cmake
index 69400698f0..1b5b1c2fd2 100644
--- a/cmake/utils/Utils.cmake
+++ b/cmake/utils/Utils.cmake
@@ -75,17 +75,17 @@ function(assign_source_group group)
endforeach()
endfunction(assign_source_group)
-# From cmake documentation:
+# From CMake documentation:
# True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number.
# False if the constant is 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, the empty
string, or ends in the suffix -NOTFOUND.
# Named boolean constants are case-insensitive.
#
# While this regex does contain a check for an empty string that check does
not work
-# cmake's regex is weak
+# CMake's regex is weak
set(IS_FALSE_PATTERN
"^[Oo][Ff][Ff]$|^0$|^[Ff][Aa][Ll][Ss][Ee]$|^[Nn][Oo]$|^[Nn][Oo][Tt][Ff][Oo][Uu][Nn][Dd]$|.*-[Nn][Oo][Tt][Ff][Oo][Uu][Nn][Dd]$|^$")
set(IS_TRUE_PATTERN
"^[Oo][Nn]$|^[1-9][0-9]*$|^[Tt][Rr][Uu][Ee]$|^[Yy][Ee][Ss]$|^[Yy]$")
-# Custom file() macro that automatically uses CONFIGURE_DEPENDS if cmake
+# Custom file() macro that automatically uses CONFIGURE_DEPENDS if CMake
# supports it. CONFIGURE_DEPENDS scans the globbed directories on each build to
# check if any files have been added/removed. This has a small build overhead,
# but ensures that you don't manually have to rerun cmake if files were added.
diff --git a/docker/bash.sh b/docker/bash.sh
index 6539f9ac51..a530af705c 100755
--- a/docker/bash.sh
+++ b/docker/bash.sh
@@ -149,7 +149,7 @@ CONTAINER_NAME=
# TODO(Lunderberg): Remove this if statement and always set to
# "${REPO_DIR}". The consistent directory for Jenkins is currently
-# necessary to allow cmake build commands to run in CI after the build
+# necessary to allow CMake build commands to run in CI after the build
# steps.
# TODO(https://github.com/apache/tvm/issues/11952):
# Figure out a better way to keep the same path
diff --git a/docker/install/ubuntu_install_python.sh
b/docker/install/ubuntu_install_python.sh
index b8828e5e41..71254c907b 100755
--- a/docker/install/ubuntu_install_python.sh
+++ b/docker/install/ubuntu_install_python.sh
@@ -82,7 +82,7 @@ mkdir -p "${venv_dir}"
python3 -mvenv "${TVM_VENV}"
# NOTE: Only in python3.9 does venv guarantee it creates the python3.X binary.
-# This is needed so that cmake's find_package(PythonInterp) works inside the
venv.
+# This is needed so that CMake's find_package(PythonInterp) works inside the
venv.
# See https://bugs.python.org/issue39656
if [ ! -e "${TVM_VENV}/bin/python${PYTHON_VERSION}" ]; then
ln -s "${TVM_VENV}/bin/python" "${TVM_VENV}/bin/python${PYTHON_VERSION}"
diff --git a/docs/install/docker.rst b/docs/install/docker.rst
index 4c68b92b9c..a311bdfd08 100644
--- a/docs/install/docker.rst
+++ b/docs/install/docker.rst
@@ -22,7 +22,8 @@ Docker Images
We provide docker utility scripts to help developers to setup development
environment.
They are also helpful run through TVM demo and tutorials.
We need `docker <https://docs.docker.com/engine/installation/>`_ and
-`nvidia-docker <https://github.com/NVIDIA/nvidia-docker/>`_ if we want to use
CUDA.
+`NVIDIA Container Toolkit
<https://github.com/NVIDIA/nvidia-container-toolkit>`_
+if we want to use CUDA.
Get a tvm source distribution or clone the GitHub repo to get the auxiliary
scripts
diff --git a/docs/install/from_source.rst b/docs/install/from_source.rst
index 9914c91e7c..3a496b83d5 100644
--- a/docs/install/from_source.rst
+++ b/docs/install/from_source.rst
@@ -267,7 +267,7 @@ There are several ways to enable CCache in TVM builds:
Building on Windows
~~~~~~~~~~~~~~~~~~~
-TVM support build via MSVC using cmake. You will need to obtain a visual
studio compiler.
+TVM support build via MSVC using CMake. You will need to obtain a visual
studio compiler.
The minimum required VS version is **Visual Studio Enterprise 2019** (NOTE: we
test
against GitHub Actions' `Windows 2019 Runner
<https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md>`_,
so see that page for full details.
We recommend following :ref:`install-dependencies` to obtain necessary
dependencies and
diff --git a/python/tvm/libinfo.py b/python/tvm/libinfo.py
index 691adf9f98..53b8e9c1cb 100644
--- a/python/tvm/libinfo.py
+++ b/python/tvm/libinfo.py
@@ -67,7 +67,7 @@ def get_dll_directories():
# Pip lib directory
dll_path.append(ffi_dir)
dll_path.append(os.path.join(ffi_dir, "lib"))
- # Default cmake build directory
+ # Default CMake build directory
dll_path.append(os.path.join(source_dir, "build"))
dll_path.append(os.path.join(source_dir, "build", "Release"))
# Default make build directory
diff --git a/python/tvm/relax/transform/transform.py
b/python/tvm/relax/transform/transform.py
index 5be0401111..515288cc4f 100644
--- a/python/tvm/relax/transform/transform.py
+++ b/python/tvm/relax/transform/transform.py
@@ -1214,6 +1214,7 @@ def MetaScheduleTuneTIR(
max_trials_global: int,
) -> tvm.ir.transform.Pass:
"""Tune TIR with MetaSchedule.
+
Parameters
----------
work_dir: str
diff --git a/src/contrib/msc/plugin/base_codegen.h
b/src/contrib/msc/plugin/base_codegen.h
index 971719d04c..45d8002438 100644
--- a/src/contrib/msc/plugin/base_codegen.h
+++ b/src/contrib/msc/plugin/base_codegen.h
@@ -247,13 +247,13 @@ class BasePluginCodeGen {
/*! \brief Codegen plugin runtime*/
virtual void CodeGenOpRuntime(const Plugin& plugin) {}
- /*! \brief Codegen cmake file*/
+ /*! \brief Codegen CMake file*/
virtual void CodeGenCmake(const std::set<ffi::String>& devices) {
CodeGenPreCmake(devices);
CodeGenPostCmake(devices);
}
- /*! \brief Codegen cmake start*/
+ /*! \brief Codegen CMake start*/
void CodeGenPreCmake(const std::set<ffi::String>& devices,
const ffi::Map<ffi::String, ffi::String>& extra_flags =
ffi::Map<ffi::String, ffi::String>()) {
@@ -281,7 +281,7 @@ class BasePluginCodeGen {
stack_.line();
}
- /*! \brief Codegen cmake end*/
+ /*! \brief Codegen CMake end*/
void CodeGenPostCmake(const std::set<ffi::String>& devices,
const ffi::Array<ffi::String>& extra_includes =
ffi::Array<ffi::String>(),
const ffi::Array<ffi::String>& extra_libs =
ffi::Array<ffi::String>()) {
diff --git a/src/contrib/msc/plugin/tensorrt_codegen.h
b/src/contrib/msc/plugin/tensorrt_codegen.h
index 579d9a5422..839a5f0927 100644
--- a/src/contrib/msc/plugin/tensorrt_codegen.h
+++ b/src/contrib/msc/plugin/tensorrt_codegen.h
@@ -73,7 +73,7 @@ class TensorRTPluginCodeGen : public
BasePluginCodeGen<TensorRTPluginCodeGenConf
/*! \brief Codegen plugin op define*/
void CodeGenOpDefine(const Plugin& plugin) final;
- /*! \brief Codegen cmake file*/
+ /*! \brief Codegen CMake file*/
void CodeGenCmake(const std::set<ffi::String>& devices) final;
/*! \brief Codegen manager methods*/
diff --git a/src/contrib/msc/plugin/torch_codegen.h
b/src/contrib/msc/plugin/torch_codegen.h
index 2a5042392e..35bf16737d 100644
--- a/src/contrib/msc/plugin/torch_codegen.h
+++ b/src/contrib/msc/plugin/torch_codegen.h
@@ -74,7 +74,7 @@ class TorchPluginCodeGen : public
BasePluginCodeGen<TorchPluginCodeGenConfig> {
/*! \brief Codegen plugin op define*/
void CodeGenOpDefine(const Plugin& plugin) final;
- /*! \brief Codegen cmake file*/
+ /*! \brief Codegen CMake file*/
void CodeGenCmake(const std::set<ffi::String>& devices) final;
/*! \brief Codegen manager depends*/
diff --git a/src/contrib/msc/plugin/tvm_codegen.h
b/src/contrib/msc/plugin/tvm_codegen.h
index d2f6774296..5311cd8632 100644
--- a/src/contrib/msc/plugin/tvm_codegen.h
+++ b/src/contrib/msc/plugin/tvm_codegen.h
@@ -77,7 +77,7 @@ class TVMPluginCodeGen : public
BasePluginCodeGen<TVMPluginCodeGenConfig> {
/*! \brief Codegen plugin runtime*/
void CodeGenOpRuntime(const Plugin& plugin) final;
- /*! \brief Codegen cmake file*/
+ /*! \brief Codegen CMake file*/
void CodeGenCmake(const std::set<ffi::String>& devices) final;
/*! \brief Codegen manager depends*/
diff --git a/src/runtime/hexagon/README.md b/src/runtime/hexagon/README.md
index b84185c5b5..b3856da3ab 100644
--- a/src/runtime/hexagon/README.md
+++ b/src/runtime/hexagon/README.md
@@ -32,7 +32,7 @@ for Hexagon. To enable that, certain elements of both, the
compiler and the
runtime need to include Hexagon-specific functionality. For the compiler, it
is code generation, and for the runtime, it is the ability to represent
modules with Hexagon code. Since Hexagon codegen is based on LLVM, LLVM
-codegen needs to be enabled as well. The set of cmake options to enable
+codegen needs to be enabled as well. The set of CMake options to enable
Hexagon support is
```
USE_LLVM=llvm-config
@@ -45,8 +45,8 @@ USE_HEXAGON_SDK=/path/to/sdk
Aside from x86, there are two other platforms where support for Hexagon may
be relevant. One of them is obviously Hexagon itself, the other one is
Android. Neither of these platforms supports the compiler side of TVM, only
-runtime, and so the only compiler-related cmake option from the x86 build
-above can be omitted: USE_LLVM.
+runtime, and so the only compiler-related CMake option from the x86 build
+above can be omitted: `USE_LLVM`.
Additionally, for Android, set the toolchain and target flags:
```
diff --git a/src/support/libinfo.cc b/src/support/libinfo.cc
index 3bc517bafa..6420627a10 100644
--- a/src/support/libinfo.cc
+++ b/src/support/libinfo.cc
@@ -257,7 +257,7 @@
namespace tvm {
/*!
- * \brief Get a dictionary containing compile-time info, including cmake flags
and git commit hash
+ * \brief Get a dictionary containing compile-time info, including CMake flags
and git commit hash
* \return The compile-time info
*/
TVM_DLL ffi::Map<ffi::String, ffi::String> GetLibInfo() {
diff --git a/src/target/datatype/posit/posit-wrapper.cc
b/src/target/datatype/posit/posit-wrapper.cc
index bb2af37ec9..e05695e603 100644
--- a/src/target/datatype/posit/posit-wrapper.cc
+++ b/src/target/datatype/posit/posit-wrapper.cc
@@ -24,7 +24,7 @@
* To compile TVM with this file,
* 1. clone the Stillwater Universal repo from here
`https://github.com/stillwater-sc/universal`.
* 2. set `SET_BYODT_POSIT` ON and `UNIVERSAL_PATH` as the path to the folder
containing Stillwater
- * Universal in your cmake file
+ * Universal in your CMake file
*
* TODO(@gussmith23 @hypercubestart) Link to BYODT docs when they exist?
*/
