Unverified Commit e4b5348e authored by Zaida Zhou's avatar Zaida Zhou Committed by GitHub
Browse files

[Docs] Refactor the structure of documentation (#1580)

* [Docs] Refactor the structure of documentation

* [Docs] Refactor the structure of documentation

* fix symlink

* fix link

* fix typo

* polish docstring

* fix docstring
parent f31f1cdb
...@@ -134,7 +134,7 @@ pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/t ...@@ -134,7 +134,7 @@ pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/t
</table> </table>
```{note} ```{note}
以上提供的预编译包并不囊括所有的 mmcv-full 版本,我们可以点击对应链接查看支持的版本。例如,点击 [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html),可以看到 `cu102-torch1.8.0` 只提供了 1.3.0 及以上的 mmcv-full 版本。另外,从 `mmcv v1.3.17` 开始,我们不再提供`PyTorch 1.3 & 1.4` 对应的 mmcv-full 预编译包。你可以在 [这](./docs_zh_CN/get_started/previous_versions.md) 找到 `PyTorch 1.3 & 1.4` 对应的预编包。虽然我们不再提供 `PyTorch 1.3 & 1.4` 对应的预编译包,但是我们依然在 CI 中保证对它们的兼容持续到下一年。 以上提供的预编译包并不囊括所有的 mmcv-full 版本,我们可以点击对应链接查看支持的版本。例如,点击 [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html),可以看到 `cu102-torch1.8.0` 只提供了 1.3.0 及以上的 mmcv-full 版本。另外,从 `mmcv v1.3.17` 开始,我们不再提供`PyTorch 1.3 & 1.4` 对应的 mmcv-full 预编译包。你可以在 [这](./previous_versions.md) 找到 `PyTorch 1.3 & 1.4` 对应的预编包。虽然我们不再提供 `PyTorch 1.3 & 1.4` 对应的预编译包,但是我们依然在 CI 中保证对它们的兼容持续到下一年。
``` ```
除了使用预编译包之外,另一种方式是在本地进行编译,直接运行下述命令 除了使用预编译包之外,另一种方式是在本地进行编译,直接运行下述命令
......
...@@ -252,9 +252,9 @@ flow = mmcv.flowread('compressed.jpg', quantize=True, concat_axis=1) ...@@ -252,9 +252,9 @@ flow = mmcv.flowread('compressed.jpg', quantize=True, concat_axis=1)
mmcv.flowshow(flow) mmcv.flowshow(flow)
``` ```
![progress](../../docs/_static/flow_visualization.png) ![progress](../../en/_static/flow_visualization.png)
3. 流变换 1. 流变换
```python ```python
img1 = mmcv.imread('img1.jpg') img1 = mmcv.imread('img1.jpg')
...@@ -264,12 +264,12 @@ warpped_img2 = mmcv.flow_warp(img1, flow) ...@@ -264,12 +264,12 @@ warpped_img2 = mmcv.flow_warp(img1, flow)
img1 (左) and img2 (右) img1 (左) and img2 (右)
![raw images](../../docs/_static/flow_raw_images.png) ![raw images](../../en/_static/flow_raw_images.png)
光流 (img2 -> img1) 光流 (img2 -> img1)
![optical flow](../../docs/_static/flow_img2toimg1.png) ![optical flow](../../en/_static/flow_img2toimg1.png)
变换后的图像和真实图像的差异 变换后的图像和真实图像的差异
![warpped image](../../docs/_static/flow_warp_diff.png) ![warpped image](../../en/_static/flow_warp_diff.png)
...@@ -17,7 +17,7 @@ mmcv.track_progress(func, tasks) ...@@ -17,7 +17,7 @@ mmcv.track_progress(func, tasks)
``` ```
效果如下 效果如下
![progress](../../docs/_static/progress.*) ![progress](../../en/_static/progress.*)
如果你想可视化多进程任务的进度,你可以使用 `track_parallel_progress` 如果你想可视化多进程任务的进度,你可以使用 `track_parallel_progress`
...@@ -25,7 +25,7 @@ mmcv.track_progress(func, tasks) ...@@ -25,7 +25,7 @@ mmcv.track_progress(func, tasks)
mmcv.track_parallel_progress(func, tasks, 8) # 8 workers mmcv.track_parallel_progress(func, tasks, 8) # 8 workers
``` ```
![progress](../../docs/_static/parallel_progress.*) ![progress](../../_static/parallel_progress.*)
如果你想要迭代或枚举数据列表并可视化进度,你可以使用 `track_iter_progress` 如果你想要迭代或枚举数据列表并可视化进度,你可以使用 `track_iter_progress`
......
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