Unverified Commit 712eafc3 authored by user4543's avatar user4543 Committed by GitHub
Browse files

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

**Description**
Update links of referencing other docs using relative file paths with extensions.
parent cb266911
...@@ -105,7 +105,7 @@ sb deploy [--docker-image] ...@@ -105,7 +105,7 @@ sb deploy [--docker-image]
| Name | Default | Description | | 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-password` | `None` | Docker registry password if authentication is needed. |
| `--docker-username` | `None` | Docker registry username if authentication is needed. | | `--docker-username` | `None` | Docker registry username if authentication is needed. |
| `--host-file` `-f` | `None` | Path to Ansible inventory host file. | | `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
......
...@@ -83,11 +83,11 @@ superbench-results ...@@ -83,11 +83,11 @@ superbench-results
#### Files to provide #### Files to provide
Besides `README` and `LICENSE` file, you should provide at least three benchmarking related files. 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. 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 python system_info.py
``` ```
* `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration) to learn the details. * `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. * `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file.
\ No newline at end of file
...@@ -11,7 +11,7 @@ You can also develop online with [GitHub Codespaces](https://github.com/codespac ...@@ -11,7 +11,7 @@ You can also develop online with [GitHub Codespaces](https://github.com/codespac
## Check Environment ## Check Environment
Follow [System Requirements](../getting-started/installation). Follow [System Requirements](../getting-started/installation.mdx).
## Set Up ## Set Up
......
...@@ -13,7 +13,7 @@ here are the guides on how to build images and start containers during developme ...@@ -13,7 +13,7 @@ here are the guides on how to build images and start containers during developme
## Build image ## 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 <Tabs
groupId='gpu-platform' groupId='gpu-platform'
......
...@@ -173,9 +173,9 @@ superbench: ...@@ -173,9 +173,9 @@ superbench:
Mappings of `${benchmark_name}: Benchmark`. Mappings of `${benchmark_name}: Benchmark`.
There are three types of benchmarks, There are three types of benchmarks,
[micro-benchmark](./user-tutorial/benchmarks/micro-benchmarks), [micro-benchmark](./user-tutorial/benchmarks/micro-benchmarks.md),
[model-benchmark](./user-tutorial/benchmarks/model-benchmarks), [model-benchmark](./user-tutorial/benchmarks/model-benchmarks.md),
and [docker-benchmark](./user-tutorial/benchmarks/docker-benchmarks). and [docker-benchmark](./user-tutorial/benchmarks/docker-benchmarks.md).
Each benchmark has its own unique name listed in docs. Each benchmark has its own unique name listed in docs.
`${benchmark_name}` can be one of the followings: `${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 ...@@ -10,11 +10,11 @@ This tool is to filter the defective machines automatically from thousands of be
## Usage ## 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. 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} 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: ...@@ -40,7 +40,7 @@ The input mainly includes 3 files:
This section describes how to write rules in **rule file**. 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: 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 ...@@ -10,7 +10,7 @@ This tool is to generate a readable summary report based on the raw benchmark re
## Usage ## 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. 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 ...@@ -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**. 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: Here is an overview of the rule file structure:
......
...@@ -7,7 +7,7 @@ author_url: https://github.com/TobeyQin ...@@ -7,7 +7,7 @@ author_url: https://github.com/TobeyQin
tags: [superbench, announcement, release] 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). 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 ...@@ -49,4 +49,4 @@ You can install and try superbench by following [Getting Started Tutorial](https
* Added examples to run benchmarks respectively. * Added examples to run benchmarks respectively.
* Tutorial Documents (introduction, getting-started, developer-guides, APIs, benchmarks). * Tutorial Documents (introduction, getting-started, developer-guides, APIs, benchmarks).
* Built SuperBench [website](https://aka.ms/superbench/). * Built SuperBench [website](https://aka.ms/superbench/).
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment