Docs - Update links using relative file paths with extensions (#346)

**Description**
Update links of referencing other docs using relative file paths with extensions.
This commit is contained in:
Yuting Jiang 2022-04-21 07:28:19 +08:00 коммит произвёл GitHub
Родитель cb26691173
Коммит 712eafc373
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
8 изменённых файлов: 16 добавлений и 16 удалений

Просмотреть файл

@ -105,7 +105,7 @@ sb deploy [--docker-image]
| Name | Default | Description |
|-----------------------|-------------------------|-------------------------------------------------------------------------------|
| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./user-tutorial/container-images) listed all images. |
| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./user-tutorial/container-images.mdx) listed all images. |
| `--docker-password` | `None` | Docker registry password if authentication is needed. |
| `--docker-username` | `None` | Docker registry username if authentication is needed. |
| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |

Просмотреть файл

@ -83,11 +83,11 @@ superbench-results
#### Files to provide
Besides `README` and `LICENSE` file, you should provide at least three benchmarking related files.
* `system.json`: This file lists all the system configurations in json format.
* `system.json`: This file lists all the system configurations in json format.
You can get the system info automatically by executing `system_info.py` using below command. The file is under `superbench/tools` folder.
```
python system_info.py
```
* `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration) to learn the details.
* `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file.
* `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration.md) to learn the details.
* `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file.

Просмотреть файл

@ -11,7 +11,7 @@ You can also develop online with [GitHub Codespaces](https://github.com/codespac
## Check Environment
Follow [System Requirements](../getting-started/installation).
Follow [System Requirements](../getting-started/installation.mdx).
## Set Up

Просмотреть файл

@ -13,7 +13,7 @@ here are the guides on how to build images and start containers during developme
## Build image
You need to [clone the code](./development#set-up) first before building the image.
You need to [clone the code](./development.md#set-up) first before building the image.
<Tabs
groupId='gpu-platform'

Просмотреть файл

@ -173,9 +173,9 @@ superbench:
Mappings of `${benchmark_name}: Benchmark`.
There are three types of benchmarks,
[micro-benchmark](./user-tutorial/benchmarks/micro-benchmarks),
[model-benchmark](./user-tutorial/benchmarks/model-benchmarks),
and [docker-benchmark](./user-tutorial/benchmarks/docker-benchmarks).
[micro-benchmark](./user-tutorial/benchmarks/micro-benchmarks.md),
[model-benchmark](./user-tutorial/benchmarks/model-benchmarks.md),
and [docker-benchmark](./user-tutorial/benchmarks/docker-benchmarks.md).
Each benchmark has its own unique name listed in docs.
`${benchmark_name}` can be one of the followings:

Просмотреть файл

@ -10,11 +10,11 @@ This tool is to filter the defective machines automatically from thousands of be
## Usage
1. [Install SuperBench](../getting-started/installation) on the local machine.
1. [Install SuperBench](../getting-started/installation.mdx) on the local machine.
2. Prepare the raw data, rule file, baseline file under current path or somewhere on the local machine.
3. After installing the Superbnech and the files are ready, you can start to filter the defective machines automatically using `sb result diagnosis` command. The detailed command can be found from [SuperBench CLI](../cli).
3. After installing the Superbnech and the files are ready, you can start to filter the defective machines automatically using `sb result diagnosis` command. The detailed command can be found from [SuperBench CLI](../cli.md).
```
sb result diagnosis --data-file ./results-summary.jsonl --rule-file ./rule.yaml --baseline-file ./baseline.json --output-file-format excel --output-dir ${output-dir}
@ -40,7 +40,7 @@ The input mainly includes 3 files:
This section describes how to write rules in **rule file**.
The convention is the same with [SuperBench Config File](https://microsoft.github.io/superbenchmark/docs/superbench-config), please view it first.
The convention is the same with [SuperBench Config File](../superbench-config.mdx), please view it first.
Here is an overview of the rule file structure:

Просмотреть файл

@ -10,7 +10,7 @@ This tool is to generate a readable summary report based on the raw benchmark re
## Usage
1. [Install SuperBench](../getting-started/installation) on the local machine.
1. [Install SuperBench](../getting-started/installation.mdx) on the local machine.
2. Prepare the raw data and rule file on the local machine.
@ -40,7 +40,7 @@ Raw data file can be found at ${output-dir}/results-summary.jsonl after each suc
This section describes how to write rules in **rule file**.
The convention is the same as [SuperBench Config File](../superbench-config), please view it first.
The convention is the same as [SuperBench Config File](../superbench-config.mdx), please view it first.
Here is an overview of the rule file structure:

Просмотреть файл

@ -7,7 +7,7 @@ author_url: https://github.com/TobeyQin
tags: [superbench, announcement, release]
---
We are very happy to announce that **SuperBench 0.2.0 version** is officially released today!
We are very happy to announce that **SuperBench 0.2.0 version** is officially released today!
You can install and try superbench by following [Getting Started Tutorial](https://microsoft.github.io/superbenchmark/docs/getting-started/installation).
@ -49,4 +49,4 @@ You can install and try superbench by following [Getting Started Tutorial](https
* Added examples to run benchmarks respectively.
* Tutorial Documents (introduction, getting-started, developer-guides, APIs, benchmarks).
* Built SuperBench [website](https://aka.ms/superbench/).
* Built SuperBench [website](https://aka.ms/superbench/).