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 4d4351dd68 [DOC] Fix various grammar and punctuation issues (#18790)
4d4351dd68 is described below
commit 4d4351dd68eaf4d29946229b73a9f477525f7b59
Author: Ruslan Baratov <[email protected]>
AuthorDate: Tue Feb 17 23:30:39 2026 +0800
[DOC] Fix various grammar and punctuation issues (#18790)
Fix various grammar and punctuation issues in next files:
- docs/arch/device_target_interactions.rst
- docs/arch/index.rst
- docs/arch/introduction_to_module_serialization.rst
- docs/arch/pass_infra.rst
- docs/contribute/document.rst
- docs/contribute/git_howto.rst
- docs/deep_dive/relax/tutorials/relax_transformation.py
- docs/reference/api/links.rst
---------
Co-authored-by: gemini-code-assist[bot]
<176961590+gemini-code-assist[bot]@users.noreply.github.com>
---
docs/arch/device_target_interactions.rst | 12 ++++++------
docs/arch/index.rst | 6 ++++--
docs/arch/introduction_to_module_serialization.rst | 4 ++--
docs/arch/pass_infra.rst | 2 +-
docs/contribute/document.rst | 6 +++---
docs/contribute/git_howto.rst | 2 +-
docs/deep_dive/relax/tutorials/relax_transformation.py | 2 +-
docs/reference/api/links.rst | 2 +-
8 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/docs/arch/device_target_interactions.rst
b/docs/arch/device_target_interactions.rst
index aa7f5e6785..7ba4a4a60a 100644
--- a/docs/arch/device_target_interactions.rst
+++ b/docs/arch/device_target_interactions.rst
@@ -114,7 +114,7 @@ access to physical device ``0``, accessed through the CUDA
API.)
``CopyDataFromTo`` completes.
-* Execution stream management - Utilities for handling
+* Execution stream management - utilities for handling
``TVMStreamHandle``, which represents parallel streams of execution
used to execute commands.
@@ -190,11 +190,11 @@ In `target_kind.cc`_, add a new declaration of
``TVM_REGISTER_TARGET_KIND``, passing a string name of the new target,
and the ``TVMDeviceExtType`` or ``DLDeviceType`` enum value for the
device on which that target should run. Typically, the target name
-and the device name will match. (e.g. The ``"cuda"`` target runs on
-the ``kDLCUDA`` device.) There are exceptions, such as when multiple
-different code generation targets can run on the same physical device.
-(e.g. The ``"llvm"`` and ``"c"`` targets both run on the ``kDLCPU``
-device type.)
+and the device name will match (e.g., the ``"cuda"`` target runs on
+the ``kDLCUDA`` device). There are exceptions, such as when multiple
+different code generation targets can run on the same physical device
+(e.g., the ``"llvm"`` and ``"c"`` targets both run on the ``kDLCPU``
+device type).
All options for a specific target kind are added with the
``add_attr_option`` function, with optional default values. A `Target`
diff --git a/docs/arch/index.rst b/docs/arch/index.rst
index a958d0229a..186227a95b 100644
--- a/docs/arch/index.rst
+++ b/docs/arch/index.rst
@@ -95,8 +95,10 @@ tir transformations contain a collection of passes that
apply to tir functions.
target-specific representation. For example, there are passes to flatten
multi-dimensional access to one-dimensional pointer access, to expand the
intrinsics into target-specific ones,
and to decorate the function entry to meet the runtime calling convention.
-Many low-level optimizations can be handled in the target phase by the LLVM,
CUDA C, and other target compilers. As a result, we leave low-level
optimizations such as register allocation
- to the downstream compilers and only focus on optimizations that are not
covered by them.
+Many low-level optimizations can be handled in the target phase by the LLVM,
+CUDA C, and other target compilers. As a result, we leave low-level
+optimizations such as register allocation to the downstream compilers and only
+focus on optimizations that are not covered by them.
cross-level transformations
^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/arch/introduction_to_module_serialization.rst
b/docs/arch/introduction_to_module_serialization.rst
index 50eeb6df22..ec6d262f33 100644
--- a/docs/arch/introduction_to_module_serialization.rst
+++ b/docs/arch/introduction_to_module_serialization.rst
@@ -118,7 +118,7 @@ blob type key is ``_lib``. For CUDA module, it is ``cuda``,
which could be got b
.. note::
Whether or not it is required to implement the SaveToBinary virtual
function depends on
- how the module is used. For example, If the module has information we need
when we load
+ how the module is used. For example, if the module has information we need
when we load
the dynamic shared library back, we should do. Like CUDA module, we need
its binary data
passing to GPU driver when we load the dynamic shared library, so we should
implement
``SaveToBinary`` to serialize its binary data. But for host module (like
DSO), we don't
@@ -144,7 +144,7 @@ Deserialization
****************
The entrance API is ``tvm.runtime.load``. This function
-is to call ``_LoadFromFile`` in fact. If we dig it a little deeper, this is
+actually calls ``_LoadFromFile``. If we dig it a little deeper, this is
``Module::LoadFromFile``. In our example, the file is ``deploy.so``,
according to the function logic, we will call ``module.loadfile_so`` in
``dso_library.cc``. The key is here:
diff --git a/docs/arch/pass_infra.rst b/docs/arch/pass_infra.rst
index 07f267c54c..6c840beeb4 100644
--- a/docs/arch/pass_infra.rst
+++ b/docs/arch/pass_infra.rst
@@ -362,7 +362,7 @@ indicates that no prerequisite is required for this pass.
Otherwise, the pass
developer has to identify and list them.
Meanwhile, a pass API endpoint is registered with the name
-``"relax.transform.FoldConstant``. This pass, therefore, becomes an entry in
the
+``"relax.transform.FoldConstant"``. This pass, therefore, becomes an entry in
the
registry that can be accessed by both C++ (e.g. the ``GetPass`` above) and
Python when needed.
diff --git a/docs/contribute/document.rst b/docs/contribute/document.rst
index 35fd52c673..a8c7f2edf8 100644
--- a/docs/contribute/document.rst
+++ b/docs/contribute/document.rst
@@ -142,8 +142,8 @@ Python Reference Documentation
We use the `numpydoc <https://numpydoc.readthedocs.io/en/latest/>`_ format to
document the function and classes. The following snippet gives an example
-docstring. We always document all the public functions, when necessary,
-provide an usage example of the features we support (as shown below).
+docstring. We always document all the public functions, and when necessary,
+provide a usage example of the features we support (as shown below).
.. code:: python
@@ -180,7 +180,7 @@ above case, there has to be a blank line before
``Parameters``, ``Returns`` and
``Examples`` in order for the doc to be built correctly. To add a new function
to
the docs, we need to add the `sphinx.autodoc
<http://www.sphinx-doc.org/en/master/ext/autodoc.html>`_ rules to
-`docs/reference/api/python
<https://github.com/apache/tvm/tree/main/docs/reference/api/python>`_).
+`docs/reference/api/python
<https://github.com/apache/tvm/tree/main/docs/reference/api/python>`_.
You can refer to the existing files under this folder on how to add the
functions.
diff --git a/docs/contribute/git_howto.rst b/docs/contribute/git_howto.rst
index ca12f6fddb..50c8f2e1fe 100644
--- a/docs/contribute/git_howto.rst
+++ b/docs/contribute/git_howto.rst
@@ -122,7 +122,7 @@ Apply only k-Latest Commits on to the main
Sometimes it is useful to only apply your k-latest changes on top of the main.
This usually happens when you have other m-commits that are already merged
before these k-commits. Directly rebase against the main might cause merge
conflicts
-on these first m-commits(which are can be safely discarded).
+on these first m-commits (which can be safely discarded).
You can instead use the following command
diff --git a/docs/deep_dive/relax/tutorials/relax_transformation.py
b/docs/deep_dive/relax/tutorials/relax_transformation.py
index 01d8e4e320..d3cecd32b3 100644
--- a/docs/deep_dive/relax/tutorials/relax_transformation.py
+++ b/docs/deep_dive/relax/tutorials/relax_transformation.py
@@ -89,7 +89,7 @@ mod.show()
#
# Custom Passes
# ~~~~~~~~~~~~~
-# We can also define our own passes. Let's taking an example of rewrite the
``relu``
+# We can also define our own passes. Let's take an example of rewriting the
``relu``
# operator to ``gelu`` operator.
#
# First, we need to write a Relax IR Mutator to do the rewriting.
diff --git a/docs/reference/api/links.rst b/docs/reference/api/links.rst
index a2a43bf7d0..6faac87493 100644
--- a/docs/reference/api/links.rst
+++ b/docs/reference/api/links.rst
@@ -21,6 +21,6 @@ Other APIs
This page contains links to API references that are built with different doc
build system.
-* `C++ doyxgen API <doxygen/index.html>`_
+* `C++ doxygen API <doxygen/index.html>`_
* `Typescript typedoc API <typedoc/index.html>`_
* `Java Javadoc API <javadoc/index.html>`_
