This is an automated email from the ASF dual-hosted git repository.
yaxingcai pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/tvm-ffi.git
The following commit(s) were added to refs/heads/dev by this push:
new 011b105 [DOCS] Update docs to reflect the new repo (#4)
011b105 is described below
commit 011b10500c0dd789f4a453723986861fa60cb9e8
Author: Tianqi Chen <[email protected]>
AuthorDate: Sat Sep 13 22:16:44 2025 -0400
[DOCS] Update docs to reflect the new repo (#4)
This PR updates the docs instruction to reflect the new repo
---
docs/conf.py | 4 ++--
docs/get_started/install.md | 4 ++--
docs/get_started/quick_start.md | 13 ++++++++-----
docs/guides/packaging.md | 6 +++---
4 files changed, 15 insertions(+), 12 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index 1477fc8..f86f9bd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -214,7 +214,7 @@ def footer_html():
html_theme_options = {
- "repository_url": "https://github.com/apache/tvm";,
+ "repository_url": "https://github.com/apache/tvm-ffi";,
"use_repository_button": True,
"extra_footer": footer_html(),
}
@@ -223,5 +223,5 @@ html_context = {
"display_github": True,
"github_user": "apache",
"github_version": "main",
- "conf_py_path": "/ffi/docs/",
+ "conf_py_path": "/docs/",
}
diff --git a/docs/get_started/install.md b/docs/get_started/install.md
index 87223d0..622f95c 100644
--- a/docs/get_started/install.md
+++ b/docs/get_started/install.md
@@ -58,7 +58,7 @@ You can also build and install tvm-ffi from source.
Developers can clone the source repository from GitHub.
```bash
-git clone --recursive https://github.com/apache/tvm tvm
+git clone --recursive https://github.com/apache/tvm-ffi
```
```{note}
@@ -70,7 +70,7 @@ by running ``git submodule update --init --recursive`` in the
root directory.
Then you can install directly in development mode
```bash
-cd tvm/ffi
+cd tvm-ffi
pip install -ve .
```
diff --git a/docs/get_started/quick_start.md b/docs/get_started/quick_start.md
index 4861aa8..8b127c9 100644
--- a/docs/get_started/quick_start.md
+++ b/docs/get_started/quick_start.md
@@ -39,8 +39,8 @@ Before starting, ensure you have:
Then obtain a copy of the tvm-ffi source code.
```bash
-git clone https://github.com/apache/tvm --recursive
-cd tvm/ffi
+git clone https://github.com/apache/tvm-ffi --recursive
+cd tvm-ffi
```
The examples are now in the example folder, you can quickly build
@@ -85,10 +85,13 @@ examples/quick_start/
#include <tvm/ffi/dtype.h>
#include <tvm/ffi/error.h>
#include <tvm/ffi/function.h>
+#include <tvm/ffi/container/tensor.h>
namespace tvm_ffi_example {
-void AddOne(DLTensor* x, DLTensor* y) {
+namespace ffi = tvm::ffi;
+
+void AddOne(ffi::Tensor x, ffi::Tensor y) {
// Validate inputs
TVM_FFI_ICHECK(x->ndim == 1) << "x must be a 1D tensor";
DLDataType f32_dtype{kDLFloat, 32, 1};
@@ -109,13 +112,13 @@ TVM_FFI_DLL_EXPORT_TYPED_FUNC(add_one_cpu,
tvm_ffi_example::AddOne);
```
**Key Points:**
-- Functions take `DLTensor*` parameters for cross-language compatibility
+- Functions take `tvm::ffi::Tensor` parameters for cross-language compatibility
- The `TVM_FFI_DLL_EXPORT_TYPED_FUNC` macro exposes the function with a given
name
### CUDA Implementation
```cpp
-void AddOneCUDA(DLTensor* x, DLTensor* y) {
+void AddOneCUDA(ffi::Tensor x, ffi::Tensor y) {
// Validation (same as CPU version)
// ...
diff --git a/docs/guides/packaging.md b/docs/guides/packaging.md
index c12fe4e..197935e 100644
--- a/docs/guides/packaging.md
+++ b/docs/guides/packaging.md
@@ -32,8 +32,8 @@ Let's start by building and running the example.
First, obtain a copy of the tvm-ffi source code.
```bash
-git clone https://github.com/apache/tvm --recursive
-cd tvm/ffi
+git clone https://github.com/apache/tvm-ffi --recursive
+cd tvm-ffi
```
The examples are now in the examples folder. You can quickly build
@@ -147,7 +147,7 @@ which can later be accessed via `tvm_ffi.load_module`.
Here's a basic example of the function implementation:
```c++
-void AddOne(DLTensor* x, DLTensor* y) {
+void AddOne(ffi::Tensor x, ffi::Tensor y) {
// ... implementation omitted ...
}
