Skip to content

Commit

Permalink
[DOCS] Update to reflect the repo name change (apache#6967)
Browse files Browse the repository at this point in the history
  • Loading branch information
tqchen authored Nov 24, 2020
1 parent 0c92772 commit 926a315
Show file tree
Hide file tree
Showing 66 changed files with 209 additions and 222 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ We do encourage everyone to work anything they are interested in.
- [Lianmin Zheng](https://github.com/merrymercy): @merrymercy

## List of Contributors
- [Full List of Contributors](https://github.com/apache/incubator-tvm/graphs/contributors)
- [Full List of Contributors](https://github.com/apache/tvm/graphs/contributors)
- To contributors: please add your name to the list.
- [Qiao Zhang](https://github.com/zhangqiaorjc)
- [Haolong Zhang](https://github.com/haolongzhangm)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
<!--- specific language governing permissions and limitations -->
<!--- under the License. -->

<img src=https://raw.githubusercontent.com/apache/incubator-tvm-site/main/images/logo/tvm-logo-small.png width=128/> Open Deep Learning Compiler Stack
<img src=https://raw.githubusercontent.com/apache/tvm-site/main/images/logo/tvm-logo-small.png width=128/> Open Deep Learning Compiler Stack
==============================================
[Documentation](https://tvm.apache.org/docs) |
[Contributors](CONTRIBUTORS.md) |
[Community](https://tvm.apache.org/community) |
[Release Notes](NEWS.md)

[![Build Status](https://ci.tlcpack.ai/buildStatus/icon?job=tvm/main)](https://ci.tlcpack.ai/job/tvm/job/main/)
[![WinMacBuild](https://github.com/apache/incubator-tvm/workflows/WinMacBuild/badge.svg)](https://github.com/apache/incubator-tvm/actions?query=workflow%3AWinMacBuild)
[![WinMacBuild](https://github.com/apache/tvm/workflows/WinMacBuild/badge.svg)](https://github.com/apache/tvm/actions?query=workflow%3AWinMacBuild)

Apache TVM (incubating) is a compiler stack for deep learning systems. It is designed to close the gap between the
productivity-focused deep learning frameworks, and the performance- and efficiency-focused hardware backends.
Expand Down
4 changes: 2 additions & 2 deletions apps/android_deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Alternatively, you may execute Docker image we provide which contains the requir

### Build APK

Before you build the Android application, please refer to [TVM4J Installation Guide](https://github.com/apache/incubator-tvm/blob/main/jvm/README.md) and install tvm4j-core to your local maven repository. You can find tvm4j dependency declare in `app/build.gradle`. Modify it if it is necessary.
Before you build the Android application, please refer to [TVM4J Installation Guide](https://github.com/apache/tvm/blob/main/jvm/README.md) and install tvm4j-core to your local maven repository. You can find tvm4j dependency declare in `app/build.gradle`. Modify it if it is necessary.

```
dependencies {
Expand Down Expand Up @@ -124,7 +124,7 @@ If everything goes well, you will find compile tools in `/opt/android-toolchain-

Follow instruction to get compiled version model for android target [here.](https://tvm.apache.org/docs/deploy/android.html)

Copied these compiled model deploy_lib.so, deploy_graph.json and deploy_param.params to apps/android_deploy/app/src/main/assets/ and modify TVM flavor changes on [java](https://github.com/apache/incubator-tvm/blob/main/apps/android_deploy/app/src/main/java/org/apache/tvm/android/demo/MainActivity.java#L81)
Copied these compiled model deploy_lib.so, deploy_graph.json and deploy_param.params to apps/android_deploy/app/src/main/assets/ and modify TVM flavor changes on [java](https://github.com/apache/tvm/blob/main/apps/android_deploy/app/src/main/java/org/apache/tvm/android/demo/MainActivity.java#L81)

`CPU Verison flavor`
```
Expand Down
6 changes: 3 additions & 3 deletions apps/android_rpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You will need JDK, [Android NDK](https://developer.android.com/ndk) and an Andro

We use [Gradle](https://gradle.org) to build. Please follow [the installation instruction](https://gradle.org/install) for your operating system.

Before you build the Android application, please refer to [TVM4J Installation Guide](https://github.com/apache/incubator-tvm/blob/main/jvm/README.md) and install tvm4j-core to your local maven repository. You can find tvm4j dependency declare in `app/build.gradle`. Modify it if it is necessary.
Before you build the Android application, please refer to [TVM4J Installation Guide](https://github.com/apache/tvm/blob/main/jvm/README.md) and install tvm4j-core to your local maven repository. You can find tvm4j dependency declare in `app/build.gradle`. Modify it if it is necessary.

```
dependencies {
Expand Down Expand Up @@ -146,7 +146,7 @@ android 1 1 0
```


Then checkout [android\_rpc/tests/android\_rpc\_test.py](https://github.com/apache/incubator-tvm/blob/main/apps/android_rpc/tests/android_rpc_test.py) and run,
Then checkout [android\_rpc/tests/android\_rpc\_test.py](https://github.com/apache/tvm/blob/main/apps/android_rpc/tests/android_rpc_test.py) and run,

```bash
# Specify the RPC tracker
Expand All @@ -157,7 +157,7 @@ export TVM_NDK_CC=/opt/android-toolchain-arm64/bin/aarch64-linux-android-g++
python android_rpc_test.py
```

This will compile TVM IR to shared libraries (CPU, OpenCL and Vulkan) and run vector addition on your Android device. To verify compiled TVM IR shared libraries on OpenCL target set `'test_opencl = True'` and on Vulkan target set `'test_vulkan = True'` in [tests/android_rpc_test.py](https://github.com/apache/incubator-tvm/blob/main/apps/android_rpc/tests/android_rpc_test.py), by default on CPU target will execute.
This will compile TVM IR to shared libraries (CPU, OpenCL and Vulkan) and run vector addition on your Android device. To verify compiled TVM IR shared libraries on OpenCL target set `'test_opencl = True'` and on Vulkan target set `'test_vulkan = True'` in [tests/android_rpc_test.py](https://github.com/apache/tvm/blob/main/apps/android_rpc/tests/android_rpc_test.py), by default on CPU target will execute.
On my test device, it gives following results.

```bash
Expand Down
4 changes: 2 additions & 2 deletions apps/benchmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## Results

See results on wiki page https://github.com/apache/incubator-tvm/wiki/Benchmark
See results on wiki page https://github.com/apache/tvm/wiki/Benchmark

## How to Reproduce

Expand Down Expand Up @@ -78,7 +78,7 @@ python3 -m tvm.exec.rpc_tracker
`python3 -m tvm.exec.rpc_server --tracker=10.77.1.123:9190 --key=rk3399`, where 10.77.1.123 is the IP address of the tracker.

* For Android device
* Build and install tvm RPC apk on your device [Help](https://github.com/apache/incubator-tvm/tree/main/apps/android_rpc).
* Build and install tvm RPC apk on your device [Help](https://github.com/apache/tvm/tree/main/apps/android_rpc).
Make sure you can pass the android rpc test. Then you have alreadly known how to register.

3. Verify the device registration
Expand Down
2 changes: 1 addition & 1 deletion apps/microtvm/reference-vm/zephyr/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ exclude = '''
)
'''
[tool.poetry]
name = "incubator-tvm"
name = "tvm"
version = "0.1.0"
description = ""
authors = ["Your Name <[email protected]>"]
Expand Down
2 changes: 1 addition & 1 deletion apps/wasm-standalone/wasm-graph/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ authors = ["TVM Contributors"]
edition = "2018"
description = "WebAssembly graph to deep learning frameworks using TVM"
readme = "README.md"
repository = "https://github.com/apache/incubator-tvm"
repository = "https://github.com/apache/tvm"
license = "Apache-2.0"
keywords = ["wasm", "machine learning", "tvm"]

Expand Down
2 changes: 1 addition & 1 deletion apps/wasm-standalone/wasm-runtime/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ version = "0.1.0"
authors = ["TVM Contributors"]
edition = "2018"
description = "WebAssembly runtime to deep learning frameworks using wasmtime"
repository = "https://github.com/apache/incubator-tvm"
repository = "https://github.com/apache/tvm"
license = "Apache-2.0"
keywords = ["wasm", "machine learning", "wasmtime"]

Expand Down
2 changes: 1 addition & 1 deletion docker/Dockerfile.demo_android
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ RUN git clone https://github.com/KhronosGroup/OpenCL-Headers /usr/local/OpenCL-H

# Build TVM
RUN cd /usr && \
git clone --depth=1 https://github.com/apache/incubator-tvm tvm --recursive && \
git clone --depth=1 https://github.com/apache/tvm tvm --recursive && \
cd /usr/tvm && \
mkdir -p build && \
cd build && \
Expand Down
2 changes: 1 addition & 1 deletion docker/Dockerfile.demo_opencl
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ RUN echo "Cloning TVM source & submodules"
ENV TVM_PAR_DIR="/usr"
RUN mkdir -p TVM_PAR_DIR && \
cd ${TVM_PAR_DIR} && \
git clone --depth=1 https://github.com/apache/incubator-tvm tvm --recursive
git clone --depth=1 https://github.com/apache/tvm tvm --recursive
#RUN git submodule update --init --recursive


Expand Down
2 changes: 1 addition & 1 deletion docker/install/install_tvm_cpu.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ set -u
set -o pipefail

cd /usr
git clone https://github.com/apache/incubator-tvm tvm --recursive
git clone https://github.com/apache/tvm tvm --recursive
cd /usr/tvm
# checkout a hash-tag
git checkout 4b13bf668edc7099b38d463e5db94ebc96c80470
Expand Down
2 changes: 1 addition & 1 deletion docker/install/install_tvm_gpu.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ set -u
set -o pipefail

cd /usr
git clone https://github.com/apache/incubator-tvm tvm --recursive
git clone https://github.com/apache/tvm tvm --recursive
cd /usr/tvm
# checkout a hash-tag
git checkout 4b13bf668edc7099b38d463e5db94ebc96c80470
Expand Down
10 changes: 2 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
project = "tvm"
author = "Apache Software Foundation"
copyright = "2020, %s" % author
github_doc_root = "https://github.com/apache/incubator-tvm/tree/main/docs/"
github_doc_root = "https://github.com/apache/tvm/tree/main/docs/"

os.environ["TVM_BUILD_DOC"] = "1"
# Version information.
Expand Down Expand Up @@ -309,12 +309,6 @@ def __call__(self, filename):
footer_copyright = "© 2020 Apache Software Foundation | All right reserved"
footer_note = " ".join(
"""
Apache TVM is an effort undergoing incubation at The Apache Software Foundation (ASF),
sponsored by the Apache Incubator. Incubation is required of all newly accepted projects
until a further review indicates that the infrastructure, communications, and decision making
process have stabilized in a manner consistent with other successful ASF projects. While
incubation status is not necessarily a reflection of the completeness or stability of the code,
it does indicate that the project has yet to be fully endorsed by the ASF.
Copyright © 2020 The Apache Software Foundation. Apache TVM, Apache, the Apache feather,
and the Apache TVM project logo are either trademarks or registered trademarks of
the Apache Software Foundation.""".split(
Expand All @@ -332,7 +326,7 @@ def __call__(self, filename):
("Blog", "https://tvm.apache.org/blog"),
("Docs", "https://tvm.apache.org/docs"),
("Conference", "https://tvmconf.org"),
("Github", "https://github.com/apache/incubator-tvm/"),
("Github", "https://github.com/apache/tvm/"),
]

header_dropdown = {
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
TVM Community Guideline
=======================

TVM adopts the Apache style model and governs by merit. We believe that it is important to create an inclusive community where everyone can use, contribute to, and influence the direction of the project. See `CONTRIBUTORS.md <https://github.com/apache/incubator-tvm/blob/main/CONTRIBUTORS.md>`_ for the current list of contributors.
TVM adopts the Apache style model and governs by merit. We believe that it is important to create an inclusive community where everyone can use, contribute to, and influence the direction of the project. See `CONTRIBUTORS.md <https://github.com/apache/tvm/blob/main/CONTRIBUTORS.md>`_ for the current list of contributors.



Expand Down
4 changes: 2 additions & 2 deletions docs/contribute/document.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Be careful to leave blank lines between sections of your documents.
In the 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 doc,
we need to add the `sphinx.autodoc <http://www.sphinx-doc.org/en/master/ext/autodoc.html>`_
rules to the `docs/api/python <https://github.com/apache/incubator-tvm/tree/main/docs/api/python>`_).
rules to the `docs/api/python <https://github.com/apache/tvm/tree/main/docs/api/python>`_).
You can refer to the existing files under this folder on how to add the functions.


Expand Down Expand Up @@ -96,7 +96,7 @@ to add comments about code logics to improve readability.
Write Tutorials
---------------
We use the `sphinx-gallery <https://sphinx-gallery.github.io/>`_ to build python tutorials.
You can find the source code under `tutorials <https://github.com/apache/incubator-tvm/tree/main/tutorials>`_ quite self explanatory.
You can find the source code under `tutorials <https://github.com/apache/tvm/tree/main/tutorials>`_ quite self explanatory.
One thing that worth noting is that the comment blocks are written in reStructuredText instead of markdown so be aware of the syntax.

The tutorial code will run on our build server to generate the document page.
Expand Down
49 changes: 21 additions & 28 deletions docs/contribute/release_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
.. _release_process:

Apache TVM (incubating) Release Process
=======================================
Apache TVM Release Process
==========================

The release manager role in TVM means you are responsible for a few different things:

Expand Down Expand Up @@ -64,13 +64,13 @@ The last step is to update the KEYS file with your code signing key https://www.
.. code-block:: bash
# the --depth=files will avoid checkout existing folders
svn co --depth=files "https://dist.apache.org/repos/dist/dev/incubator/tvm" svn-tvm
svn co --depth=files "https://dist.apache.org/repos/dist/dev/tvm" svn-tvm
cd svn-tvm
# edit KEYS file
svn ci --username $ASF_USERNAME --password "$ASF_PASSWORD" -m "Update KEYS"
# update downloads.apache.org
svn rm --username $ASF_USERNAME --password "$ASF_PASSWORD" https://dist.apache.org/repos/dist/release/incubator/tvm/KEYS -m "Update KEYS"
svn cp --username $ASF_USERNAME --password "$ASF_PASSWORD" https://dist.apache.org/repos/dist/dev/incubator/tvm/KEYS https://dist.apache.org/repos/dist/release/incubator/tvm/ -m "Update KEYS"
svn rm --username $ASF_USERNAME --password "$ASF_PASSWORD" https://dist.apache.org/repos/dist/release/tvm/KEYS -m "Update KEYS"
svn cp --username $ASF_USERNAME --password "$ASF_PASSWORD" https://dist.apache.org/repos/dist/dev/tvm/KEYS https://dist.apache.org/repos/dist/release/tvm/ -m "Update KEYS"
Cut a Release Candidate
Expand All @@ -80,8 +80,8 @@ To cut a release candidate, one needs to first cut a branch using selected versi

.. code-block:: bash
git clone https://github.com/apache/incubator-tvm.git
cd incubator-tvm/
git clone https://github.com/apache/tvm.git
cd tvm/
git branch v0.6.0
git push --set-upstream origin v0.6.0
Expand All @@ -107,16 +107,16 @@ Create source code artifacts,

.. code-block:: bash
git clone [email protected]:apache/incubator-tvm.git apache-tvm-src-v0.6.0.rc0-incubating
cd apache-tvm-src-v0.6.0.rc0-incubating
git clone [email protected]:apache/tvm.git apache-tvm-src-v0.6.0.rc0
cd apache-tvm-src-v0.6.0.rc0
git checkout v0.6
git submodule update --init --recursive
git checkout v0.6.0.rc0
rm -rf .DS_Store
find . -name ".git*" -print0 | xargs -0 rm -rf
cd ..
brew install gnu-tar
gtar -czvf apache-tvm-src-v0.6.0.rc0-incubating.tar.gz apache-tvm-src-v0.6.0.rc0-incubating
gtar -czvf apache-tvm-src-v0.6.0.rc0.tar.gz apache-tvm-src-v0.6.0.rc0
Use your GPG key to sign the created artifact. First make sure your GPG is set to use the correct private key,

Expand All @@ -129,8 +129,8 @@ Create GPG signature as well as the hash of the file,

.. code-block:: bash
gpg --armor --output apache-tvm-src-v0.6.0.rc0-incubating.tar.gz.asc --detach-sig apache-tvm-src-v0.6.0.rc0-incubating.tar.gz
shasum -a 512 apache-tvm-src-v0.6.0.rc0-incubating.tar.gz > apache-tvm-src-v0.6.0.rc0-incubating.tar.gz.sha512
gpg --armor --output apache-tvm-src-v0.6.0.rc0.tar.gz.asc --detach-sig apache-tvm-src-v0.6.0.rc0.tar.gz
shasum -a 512 apache-tvm-src-v0.6.0.rc0.tar.gz > apache-tvm-src-v0.6.0.rc0.tar.gz.sha512
Upload the Release Candidate
Expand All @@ -143,7 +143,7 @@ The release manager also needs to upload the artifacts to ASF SVN,
.. code-block:: bash
# the --depth=files will avoid checkout existing folders
svn co --depth=files "https://dist.apache.org/repos/dist/dev/incubator/tvm" svn-tvm
svn co --depth=files "https://dist.apache.org/repos/dist/dev/tvm" svn-tvm
cd svn-tvm
mkdir tvm-v0.6.0-rc0
# copy files into it
Expand All @@ -154,24 +154,17 @@ The release manager also needs to upload the artifacts to ASF SVN,
Call a Vote on the Release Candidate
------------------------------------

As an incubator project, it requires voting on both dev@ and general@.

The first voting takes place on the Apache TVM (incubator) developers list ([email protected]). To get more attention, one can create a github issue start with "[VOTE]" instead, it will be mirrored to dev@ automatically. Look at past voting threads to see how this proceeds. The email should follow this format.
The first voting takes place on the Apache TVM developers list ([email protected]). To get more attention, one can create a github issue start with "[VOTE]" instead, it will be mirrored to dev@ automatically. Look at past voting threads to see how this proceeds. The email should follow this format.

- Provide the link to the draft of the release notes in the email
- Provide the link to the release candidate artifacts
- Make sure the email is in text format and the links are correct

For the dev@ vote, there must be at least 3 binding +1 votes and more +1 votes than -1 votes. Once the vote is done, you should also send out a summary email with the totals, with a subject that looks something like [VOTE][RESULT] ....

The voting then moves onto the [email protected]. Anyone can contribute a vote, but only "Incubator PMC" (IPMC) votes are binding.
To pass, there must be 3 binding +1 votes and more +1 votes than -1 votes.

In ASF, votes are open "at least" 72hrs (3 days). If you don't get enough number of binding votes within that time, you cannot close the voting deadline. You need to extend it.

Same as the one on dev@, send out a summary email to general@ once the vote passes.

If either voting fails, the community needs to modified the release accordingly, create a new release candidate and re-run the voting process.
If the voting fails, the community needs to modified the release accordingly, create a new release candidate and re-run the voting process.


Post the Release
Expand All @@ -182,12 +175,12 @@ After the vote passes, to upload the binaries to Apache mirrors, you move the bi
.. code-block:: bash
export SVN_EDITOR=vim
svn mkdir https://dist.apache.org/repos/dist/release/incubator/tvm
svn mv https://dist.apache.org/repos/dist/dev/incubator/tvm/tvm-v0.6.0-rc2 https://dist.apache.org/repos/dist/release/incubator/tvm/tvm-v0.6.0
svn mkdir https://dist.apache.org/repos/dist/release/tvm
svn mv https://dist.apache.org/repos/dist/dev/tvm/tvm-v0.6.0-rc2 https://dist.apache.org/repos/dist/release/tvm/tvm-v0.6.0
# If you've added your signing key to the KEYS file, also update the release copy.
svn co --depth=files "https://dist.apache.org/repos/dist/release/incubator/tvm" svn-tvm
curl "https://dist.apache.org/repos/dist/dev/incubator/tvm/KEYS" > svn-tvm/KEYS
svn co --depth=files "https://dist.apache.org/repos/dist/release/tvm" svn-tvm
curl "https://dist.apache.org/repos/dist/dev/tvm/KEYS" > svn-tvm/KEYS
(cd svn-tvm && svn ci --username $ASF_USERNAME --password "$ASF_PASSWORD" -m"Update KEYS")
Remember to create a new release TAG (v0.6.0 in this case) on Github and remove the pre-release candidate TAG.
Expand All @@ -200,10 +193,10 @@ Remember to create a new release TAG (v0.6.0 in this case) on Github and remove
Update the TVM Website
----------------------

The website repository is located at `https://github.com/apache/incubator-tvm-site <https://github.com/apache/incubator-tvm-site>`_. Modify the download page to include the release artifacts as well as the GPG signature and SHA hash.
The website repository is located at `https://github.com/apache/tvm-site <https://github.com/apache/tvm-site>`_. Modify the download page to include the release artifacts as well as the GPG signature and SHA hash.


Post the Announcement
---------------------

Send out an announcement email to [email protected], [email protected], and [email protected]. The announcement should include the link to release note and download page.
Send out an announcement email to [email protected], and [email protected]. The announcement should include the link to release note and download page.
Loading

0 comments on commit 926a315

Please sign in to comment.