Skip to content

Commit

Permalink
[Doc] Updated URL (#4990)
Browse files Browse the repository at this point in the history
* Updated URL

* Updated URL

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
writinwaters and pre-commit-ci[bot] authored May 17, 2022
1 parent 6764b88 commit ac1f06f
Show file tree
Hide file tree
Showing 26 changed files with 39 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

<!-- We've collected some common issue solutions in https://docs.taichi-lang.org/lang/articles/install. Make sure you've check them out first. Hopefully they could address your problem. -->
<!-- We've collected some common issue solutions in https://docs.taichi-lang.org/docs/install. Make sure you've check them out first. Hopefully they could address your problem. -->

**Describe the bug**
A clear and concise description of what the bug is, ideally within 20 words.
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
blank_issues_enabled: true
contact_links:
- name: Contributor Guideline
url: https://docs.taichi-lang.org/lang/articles/contributor_guide
url: https://docs.taichi-lang.org/docs/contributor_guide
about: Please check this out if you'd like to contribute by opening a PR :)
- name: Taichi Forum
url: https://forum.taichi.graphics
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Related issue = #
Thank you for your contribution!
If it is your first time contributing to Taichi, please read our Contributor Guidelines:
https://docs.taichi-lang.org/lang/articles/contributor_guide
https://docs.taichi-lang.org/docs/contributor_guide
- Please always prepend your PR title with tags such as [CUDA], [Lang], [Doc], [Example]. For a complete list of valid PR tags, please check out https://github.com/taichi-dev/taichi/blob/master/misc/prtags.json.
- Use upper-case tags (e.g., [Metal]) for PRs that change public APIs. Otherwise, please use lower-case tags (e.g., [metal]).
- More details: https://docs.taichi-lang.org/lang/articles/contributor_guide#pr-title-format-and-tags
- More details: https://docs.taichi-lang.org/docs/contributor_guide#pr-title-format-and-tags
- Please fill in the issue number that this PR relates to.
- If your PR fixes the issue **completely**, use the `close` or `fixes` prefix so that GitHub automatically closes the issue when the PR is merged. For example,
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cmake_minimum_required(VERSION 3.15)
project(taichi)

if (NOT DEFINED TI_VERSION_MAJOR)
message(WARNING "It seems that you are running cmake manually, which may cause issues. Please use setup.py to build taichi from source, see https://docs.taichi-lang.org/lang/articles/dev_install for more details.")
message(WARNING "It seems that you are running cmake manually, which may cause issues. Please use setup.py to build taichi from source, see https://docs.taichi-lang.org/docs/dev_install for more details.")
set(TI_VERSION_MAJOR 0)
set(TI_VERSION_MINOR 0)
set(TI_VERSION_PATCH 0)
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing Guide

Thank you for your interest in contributing to Taichi! Please check out the [Contribution Guidelines](https://docs.taichi-lang.org/lang/articles/contributor_guide) for how to make a contribution.
Thank you for your interest in contributing to Taichi! Please check out the [Contribution Guidelines](https://docs.taichi-lang.org/docs/contributor_guide) for how to make a contribution.

All contributors are expected to follow the [code of conduct](https://github.com/taichi-dev/taichi/blob/master/CODE_OF_CONDUCT.md).

## Developer installation

Taichi is developed mainly in C++17 and Python3. Please check out the [Developer Installation](https://docs.taichi-lang.org/lang/articles/dev_install) to build Taichi from source. Note that Taichi is LLVM-10.0.0 dependent and that we recommend installing [our pre-built LLVM libraries](https://docs.taichi-lang.org/lang/articles/dev_install#install-llvm) for your platform.
Taichi is developed mainly in C++17 and Python3. Please check out the [Developer Installation](https://docs.taichi-lang.org/docs/dev_install) to build Taichi from source. Note that Taichi is LLVM-10.0.0 dependent and that we recommend installing [our pre-built LLVM libraries](https://docs.taichi-lang.org/docs/dev_install#install-llvm) for your platform.

## Contribution opportunities

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ The language has broad applications spanning real-time physical simulation, numb
## Why Taichi?

- Built around Python: Taichi shares almost the same syntax with Python, allowing you to write algorithms with minimal language barrier. It is also well integrated into the Python ecosystem, including NumPy and PyTorch.
- Flexibility: Taichi provides a set of generic data containers known as *SNode* (/ˈsnoʊd/), an effective mechanism for composing hierarchical, multi-dimensional fields. This can cover many use patterns in numerical simulation (e.g. [spatially sparse computing](https://docs.taichi-lang.org/lang/articles/sparse)).
- Flexibility: Taichi provides a set of generic data containers known as *SNode* (/ˈsnoʊd/), an effective mechanism for composing hierarchical, multi-dimensional fields. This can cover many use patterns in numerical simulation (e.g. [spatially sparse computing](https://docs.taichi-lang.org/docs/sparse)).
- Performance: With the `@ti.kernel` decorator, Taichi's JIT compiler automatically compiles your Python functions into efficient GPU or CPU machine code for parallel execution.
- Portability: Write your code once and run it everywhere. Currently, Taichi supports most mainstream GPU APIs, such as CUDA and Vulkan.
- ... and many more features! A cross-platform, Vulkan-based 3D visualizer, [differentiable programming](https://docs.taichi-lang.org/lang/articles/differentiable_programming), [quantized computation](https://github.com/taichi-dev/quantaichi) (experimental), etc.
- ... and many more features! A cross-platform, Vulkan-based 3D visualizer, [differentiable programming](https://docs.taichi-lang.org/docs/differentiable_programming), [quantized computation](https://github.com/taichi-dev/quantaichi) (experimental), etc.

## Getting Started

Expand Down Expand Up @@ -123,7 +123,7 @@ See [Get started](https://docs.taichi-lang.org) for more information.

### Build from source

If you wish to try our our experimental features or build Taichi for your own environments, see [Developer installation](https://docs.taichi-lang.org/lang/articles/dev_install).
If you wish to try our our experimental features or build Taichi for your own environments, see [Developer installation](https://docs.taichi-lang.org/docs/dev_install).

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion benchmarks/microbenchmarks/_items.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def __init__(self):
class MathOps(BenchmarkItem):
name = 'math_op'

#reference: https://docs.taichi-lang.org/lang/articles/operator
#reference: https://docs.taichi-lang.org/docs/operator
def __init__(self):
self._items = {
# Trigonometric
Expand Down
4 changes: 2 additions & 2 deletions build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ if (-not $LlvmDir) {
}
if (-not $LlvmDir -or -not (Test-Path $LlvmDir)) {
throw "LLVM cannot be found in local environment and the script failed to download a prebuilt archive. " +
"Please follow the instructions at 'https://docs.taichi-lang.org/lang/articles/dev_install' to manually configure LLVM for Taichi."
"Please follow the instructions at 'https://docs.taichi-lang.org/docs/dev_install' to manually configure LLVM for Taichi."
} else {
$LlvmDir = (Resolve-Path $LlvmDir).Path;
$env:LLVM_DIR = $LlvmDir
Expand All @@ -124,7 +124,7 @@ if (-not $ClangDir) {
}
if (-not $ClangDir -or -not (Test-Path $ClangDir)) {
throw "Clang cannot be found in local environment and the script failed to download a prebuilt archive. " +
"Please follow the instructions at 'https://docs.taichi-lang.org/lang/articles/dev_install' to manually configure Clang for Taichi."
"Please follow the instructions at 'https://docs.taichi-lang.org/docs/dev_install' to manually configure Clang for Taichi."
} else {
$ClangDir = (Resolve-Path $ClangDir).Path;
Write-Host "Using Clang at '$ClangDir'."
Expand Down
3 changes: 1 addition & 2 deletions python/taichi/_lib/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ def import_ti_core():
if isinstance(e, ImportError):
print(Fore.YELLOW + "Share object taichi_core import failed, "
"check this page for possible solutions:\n"
"https://docs.taichi-lang.org/lang/articles/install" +
Fore.RESET)
"https://docs.taichi-lang.org/docs/install" + Fore.RESET)
if get_os_name() == 'win':
# pylint: disable=E1101
e.msg += '\nConsider installing Microsoft Visual C++ Redistributable: https://aka.ms/vs/16/release/vc_redist.x64.exe'
Expand Down
4 changes: 2 additions & 2 deletions python/taichi/_logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def set_logging_level(level):
also be effective. For example if `level` is set to 'warn', then the levels below
it, which are 'error' and 'critical' in this case, will also be effective.
See also https://docs.taichi-lang.org/lang/articles/utilities#logging.
See also https://docs.taichi-lang.org/docs/utilities#logging.
Args:
level (str): Logging level.
Expand All @@ -53,7 +53,7 @@ def is_logging_effective(level):
All levels below current level will be effective.
The default level is 'info'.
See also https://docs.taichi-lang.org/lang/articles/utilities#logging.
See also https://docs.taichi-lang.org/docs/utilities#logging.
Args:
level (str): The string represents logging level. \
Expand Down
6 changes: 3 additions & 3 deletions python/taichi/lang/impl.py
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ def __repr__(self):
root = _Root()
"""Root of the declared Taichi :func:`~taichi.lang.impl.field`s.
See also https://docs.taichi-lang.org/lang/articles/layout
See also https://docs.taichi-lang.org/docs/layout
Example::
Expand Down Expand Up @@ -524,7 +524,7 @@ def field(dtype, shape=None, name="", offset=None, needs_grad=False):
actually defined. The data in a Taichi field can be directly accessed by
a Taichi :func:`~taichi.lang.kernel_impl.kernel`.
See also https://docs.taichi-lang.org/lang/articles/field
See also https://docs.taichi-lang.org/docs/field
Args:
dtype (DataType): data type of the field.
Expand Down Expand Up @@ -779,7 +779,7 @@ def static(x, *xs):
`static()` is what enables the so-called metaprogramming in Taichi. It is
in many ways similar to ``constexpr`` in C++.
See also https://docs.taichi-lang.org/lang/articles/meta.
See also https://docs.taichi-lang.org/docs/meta.
Args:
x (Any): an expression to be evaluated
Expand Down
4 changes: 2 additions & 2 deletions python/taichi/lang/kernel_impl.py
Original file line number Diff line number Diff line change
Expand Up @@ -892,7 +892,7 @@ def kernel(fn):
Kernel's gradient kernel would be generated automatically by the AutoDiff system.
See also https://docs.taichi-lang.org/lang/articles/syntax#kernel.
See also https://docs.taichi-lang.org/docs/syntax#kernel.
Args:
fn (Callable): the Python function to be decorated
Expand Down Expand Up @@ -941,7 +941,7 @@ def data_oriented(cls):
To allow for modularized code, Taichi provides this decorator so that
Taichi kernels can be defined inside a class.
See also https://docs.taichi-lang.org/lang/articles/odop
See also https://docs.taichi-lang.org/docs/odop
Example::
Expand Down
4 changes: 2 additions & 2 deletions python/taichi/lang/matrix.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def _linearize_entry_id(self, *args):
'If you want to *iterate through matrix elements*, use a static range:\n'
' for i in ti.static(range(3)):\n'
' print(i, "-th component is", vec[i])\n'
'See https://docs.taichi-lang.org/lang/articles/meta#when-to-use-tistatic-with-for-loops for more details.'
'See https://docs.taichi-lang.org/docs/meta#when-to-use-tistatic-with-for-loops for more details.'
'Or turn on ti.init(..., dynamic_index=True) to support indexing with variables!'
)
assert 0 <= args[0] < self.n, \
Expand Down Expand Up @@ -455,7 +455,7 @@ def __init__(self, arr, dt=None, suppress_warning=False, is_ref=False):
' So the compilation time could be extremely long if the matrix size is too big.'
' You may use a field to store a large matrix like this, e.g.:\n'
f' x = ti.field(ti.f32, ({self.n}, {self.m})).\n'
' See https://docs.taichi-lang.org/lang/articles/field#matrix-size'
' See https://docs.taichi-lang.org/docs/field#matrix-size'
' for more details.',
UserWarning,
stacklevel=2)
Expand Down
4 changes: 2 additions & 2 deletions python/taichi/lang/misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ def init(arch=None,
* ``cpu_max_num_threads`` (int): Sets the number of threads used by the CPU thread pool.
* ``debug`` (bool): Enables the debug mode, under which Taichi does a few more things like boundary checks.
* ``print_ir`` (bool): Prints the CHI IR of the Taichi kernels.
* ``packed`` (bool): Enables the packed memory layout. See https://docs.taichi-lang.org/lang/articles/layout.
* ``packed`` (bool): Enables the packed memory layout. See https://docs.taichi-lang.org/docs/layout.
"""
# Check version for users every 7 days if not disabled by users.
_version_check.start_version_check_thread()
Expand Down Expand Up @@ -476,7 +476,7 @@ def no_activate(*args):
def block_local(*args):
"""Hints Taichi to cache the fields and to enable the BLS optimization.
Please visit https://docs.taichi-lang.org/lang/articles/performance
Please visit https://docs.taichi-lang.org/docs/performance
for how BLS is used.
Args:
Expand Down
2 changes: 1 addition & 1 deletion python/taichi/lang/snode.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class SNode:
For more information on Taichi's SNode system, please check out
these references:
* https://docs.taichi-lang.org/lang/articles/sparse
* https://docs.taichi-lang.org/docs/sparse
* https://yuanming.taichi.graphics/publication/2019-taichi/taichi-lang.pdf
Arg:
Expand Down
2 changes: 1 addition & 1 deletion python/taichi/profiler/kernel_metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class CuptiMetric:
>>> ti.profiler.print_kernel_profiler_info('trace')
Note:
For details about using CUPTI in Taichi, please visit https://docs.taichi-lang.org/lang/articles/profiler#advanced-mode.
For details about using CUPTI in Taichi, please visit https://docs.taichi-lang.org/docs/profiler#advanced-mode.
"""
def __init__(self,
name='',
Expand Down
4 changes: 2 additions & 2 deletions python/taichi/profiler/kernel_profiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class KernelProfiler:
This mode is only available for the CUDA backend with CUPTI toolkit, i.e. you need ``ti.init(kernel_profiler=True, arch=ti.cuda)``.
Note:
For details about using CUPTI in Taichi, please visit https://docs.taichi-lang.org/lang/articles/profiler#advanced-mode.
For details about using CUPTI in Taichi, please visit https://docs.taichi-lang.org/docs/profiler#advanced-mode.
"""
def __init__(self):
self._profiling_mode = False
Expand Down Expand Up @@ -388,7 +388,7 @@ def print_kernel_profiler_info(mode='count'):
Currently the result of `KernelProfiler` could be incorrect on OpenGL
backend due to its lack of support for `ti.sync()`.
For advanced mode of `KernelProfiler`, please visit https://docs.taichi-lang.org/lang/articles/profiler#advanced-mode.
For advanced mode of `KernelProfiler`, please visit https://docs.taichi-lang.org/docs/profiler#advanced-mode.
"""
get_default_kernel_profiler().print_info(mode)

Expand Down
2 changes: 1 addition & 1 deletion python/taichi/types/annotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ class Template:
"""Type annotation for template kernel parameter.
Useful for passing parameters to kernels by reference.
See also https://docs.taichi-lang.org/lang/articles/meta.
See also https://docs.taichi-lang.org/docs/meta.
Args:
tensor (Any): unused
Expand Down
2 changes: 1 addition & 1 deletion taichi/analysis/verify.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class IRVerifier : public BasicStmtVisitor {
found,
"IR broken: stmt {} {} cannot have operand {} {}."
" If you are using autodiff, please check"
" https://docs.taichi-lang.org/lang/articles/"
" https://docs.taichi-lang.org/docs/"
"differences_between_taichi_and_python_programs"
" If it doesn't help, please report this bug by opening an issue at"
" https://github.com/taichi-dev/taichi to help us improve."
Expand Down
4 changes: 2 additions & 2 deletions taichi/backends/cuda/cupti_toolkit.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ bool check_cupti_availability() {
"7.0 , fallback to default kernel profiler");
TI_WARN(
"See also: "
"https://docs.taichi-lang.org/lang/articles/profiler");
"https://docs.taichi-lang.org/docs/profiler");
return false;
}
return true;
Expand Down Expand Up @@ -106,7 +106,7 @@ bool check_cupti_privileges() {
"=================================================================");
TI_WARN(
"See also: "
"https://docs.taichi-lang.org/lang/articles/profiler");
"https://docs.taichi-lang.org/docs/profiler");
return false;
}
// For other errors , CuptiToolkit::init_cupti() will send error message.
Expand Down
2 changes: 1 addition & 1 deletion taichi/gui/x11.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ void GUI::create_window() {
"Taichi fails to create a window."
" This is probably due to the lack of an X11 GUI environment."
" Consider using the `ti.GUI(show_gui=False)` option, see"
" https://docs.taichi-lang.org/lang/articles/gui_system");
" https://docs.taichi-lang.org/docs/gui_system");
visual = DefaultVisual(display, 0);
window =
XCreateSimpleWindow((Display *)display, RootWindow((Display *)display, 0),
Expand Down
2 changes: 1 addition & 1 deletion taichi/ir/snode.h
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ class SNode {
std::string name;
// Product of the |shape| of all the activated axes identified by
// |extractors|.
// See https://docs.taichi-lang.org/lang/articles/internal for terms
// See https://docs.taichi-lang.org/docs/internal for terms
// like cell and container.
int64 num_cells_per_container{1};
int total_num_bits{0};
Expand Down
2 changes: 1 addition & 1 deletion taichi/system/traceback.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ void print_traceback() {
fmt::print(
fg(fmt::color::orange),
"\nInternal error occurred. Check out this page for possible solutions:\n"
"https://docs.taichi-lang.org/lang/articles/install\n");
"https://docs.taichi-lang.org/docs/install\n");
}

TI_NAMESPACE_END
2 changes: 1 addition & 1 deletion taichi/transforms/reverse_segments.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ void reverse_segments(IRNode *root) {
"Mixed usage of for-loops and statements without looping. \n"
"Please split them into two kernels "
"and check the documentation for more details:\n"
"https://docs.taichi-lang.org/lang/articles/"
"https://docs.taichi-lang.org/docs/"
"differentiable_programming");
}
for (auto &sblock : statement_blocks) {
Expand Down
2 changes: 1 addition & 1 deletion tests/python/test_fields_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ def assign_field_multiple_struct_for():


# We currently only consider data types that all platforms support.
# See https://docs.taichi-lang.org/lang/articles/type#primitive-types for more details.
# See https://docs.taichi-lang.org/docs/type#primitive-types for more details.
@pytest.mark.parametrize('test_1d_size', [1, 10, 100])
@pytest.mark.parametrize('field_type', [ti.f32, ti.i32])
@test_utils.test(arch=[ti.cpu, ti.cuda, ti.vulkan, ti.metal])
Expand Down
2 changes: 1 addition & 1 deletion tests/python/test_simple_matrix_slice.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def test_one_col_slice() -> ti.types.matrix(1, 3, dtype=ti.i32):
r'If you want to \*iterate through matrix elements\*, use a static range:\n'
r' for i in ti.static\(range\(3\)\):\n'
r' print\(i, "-th component is", vec\[i\]\)\n'
r'See https://docs.taichi-lang.org/lang/articles/meta#when-to-use-tistatic-with-for-loops for more details.'
r'See https://docs.taichi-lang.org/docs/meta#when-to-use-tistatic-with-for-loops for more details.'
r'Or turn on ti.init\(..., dynamic_index=True\) to support indexing with variables!'
):
test_one_col_slice()

0 comments on commit ac1f06f

Please sign in to comment.