Skip to content

Commit

Permalink
Updata broken links (#502)
Browse files Browse the repository at this point in the history
* Update all broken links
  • Loading branch information
JingxianKe authored Aug 4, 2023
1 parent a2790eb commit 672ae82
Show file tree
Hide file tree
Showing 26 changed files with 74 additions and 74 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ We appreciate all contributions. If you are interested in contributing to `yolor

- If you would like to fix a bug

- please pick one from the [list of open issues labelled as "help wanted"](https://github.com/zhiqwang/yolov5-rt-stack/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
- please pick one from the [list of open issues labelled as "help wanted"](https://github.com/zhiqwang/yolort/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
- comment on the issue that you want to work on this issue
- send a PR with your fix, see below.

Expand All @@ -42,7 +42,7 @@ conda install pytorch torchvision cudatoolkit=10.2 -c pytorch

```bash
git clone https://github.com/zhiqwang/yolort.git
cd yolov5-rt-stack
cd yolort
pip install -e .
```

Expand Down Expand Up @@ -102,7 +102,7 @@ If all previous checks (flake8, mypy, unit tests) are passing, please send a PR.
- :white_check_mark: Verify your PR is **up-to-date with upstream/main**. You could update your PR to upstream/main by running the following code, don't forget replacing 'feature' with the name of your local branch:

```bash
git remote add upstream https://github.com/zhiqwang/yolov5-rt-stack.git
git remote add upstream https://github.com/zhiqwang/yolort.git
git fetch upstream
git rebase upstream/main
git checkout -b feature # <--- REPLACE 'feature' WITH YOUR LOCAL BRANCH NAME
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/zhiqwang/yolov5-rt-stack/issues?q=is%3Aissue+sort%3Acreated-desc+).
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/zhiqwang/yolort/issues?q=is%3Aissue+sort%3Acreated-desc+).
- type: textarea
attributes:
label: 🐛 Describe the bug
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Usage questions
url: https://github.com/zhiqwang/yolov5-rt-stack/discussions
url: https://github.com/zhiqwang/yolort/discussions
about: Ask questions and discuss with other yolort community members
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: 📚 Documentation
description: Report an issue related to https://github.com/zhiqwang/yolov5-rt-stack/tree/master/docs
description: Report an issue related to https://github.com/zhiqwang/yolort/tree/master/docs

body:
- type: textarea
attributes:
label: 📚 The doc issue
description: >
A clear and concise description of what content in https://github.com/zhiqwang/yolov5-rt-stack/tree/master/docs is an issue.
A clear and concise description of what content in https://github.com/zhiqwang/yolort/tree/master/docs is an issue.
validations:
required: true
- type: textarea
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ ______________________________________________________________________
[Installation Instructions](https://zhiqwang.com/yolort/installation.html)
[Deployment](#-deployment)
[Contributing](.github/CONTRIBUTING.md)
[Reporting Issues](https://github.com/zhiqwang/yolov5-rt-stack/issues/new?assignees=&labels=&template=bug-report.yml)
[Reporting Issues](https://github.com/zhiqwang/yolort/issues/new?assignees=&labels=&template=bug-report.yml)

______________________________________________________________________

[![Python Version](https://img.shields.io/badge/Python-3.6--3.10-FFD43B?logo=python)](https://pypi.org/project/yolort/)
[![PyPI version](https://img.shields.io/pypi/v/yolort?color=4D97FF&logo=PyPI)](https://badge.fury.io/py/yolort)
[![PyPI downloads](https://static.pepy.tech/personalized-badge/yolort?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=pypi%20downloads)](https://pepy.tech/project/yolort)
[![Github downloads](https://img.shields.io/github/downloads/zhiqwang/yolov5-rt-stack/total?label=Model%20downloads&logo=PyTorch&color=FF6F00&logoColor=EE4C2C)](https://github.com/zhiqwang/yolov5-rt-stack/releases)
[![Github downloads](https://img.shields.io/github/downloads/zhiqwang/yolort/total?label=Model%20downloads&logo=PyTorch&color=FF6F00&logoColor=EE4C2C)](https://github.com/zhiqwang/yolort/releases)
[![Slack](https://img.shields.io/badge/Slack%20chat-4A154B?logo=slack&logoColor=white)](https://join.slack.com/t/yolort/shared_invite/zt-mqwc7235-940aAh8IaKYeWclrJx10SA)
[![PRs Welcome](https://img.shields.io/badge/PRs%20welcome-792EE5?logo=GitHub-Sponsors&logoColor=#white)](.github/CONTRIBUTING.md)

[![CI testing](https://github.com/zhiqwang/yolov5-rt-stack/actions/workflows/ci-test.yml/badge.svg)](https://github.com/zhiqwang/yolov5-rt-stack/actions/workflows/ci-test.yml)
[![Build & deploy docs](https://github.com/zhiqwang/yolov5-rt-stack/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/zhiqwang/yolov5-rt-stack/tree/gh-pages)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/zhiqwang/yolov5-rt-stack/main.svg)](https://results.pre-commit.ci/latest/github/zhiqwang/yolov5-rt-stack/main)
[![codecov](https://codecov.io/gh/zhiqwang/yolov5-rt-stack/branch/main/graph/badge.svg?token=1GX96EA72Y)](https://codecov.io/gh/zhiqwang/yolov5-rt-stack)
[![CI testing](https://github.com/zhiqwang/yolort/actions/workflows/ci-test.yml/badge.svg)](https://github.com/zhiqwang/yolort/actions/workflows/ci-test.yml)
[![Build & deploy docs](https://github.com/zhiqwang/yolort/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/zhiqwang/yolort/tree/gh-pages)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/zhiqwang/yolort/main.svg)](https://results.pre-commit.ci/latest/github/zhiqwang/yolort/main)
[![codecov](https://codecov.io/gh/zhiqwang/yolort/branch/main/graph/badge.svg?token=1GX96EA72Y)](https://codecov.io/gh/zhiqwang/yolort)

______________________________________________________________________

Expand Down Expand Up @@ -74,8 +74,8 @@ There are no extra compiled components in `yolort` and package dependencies are

```shell
# clone yolort repository locally
git clone https://github.com/zhiqwang/yolov5-rt-stack.git
cd yolov5-rt-stack
git clone https://github.com/zhiqwang/yolort.git
cd yolort
# install in editable mode
pip install -e .
```
Expand Down Expand Up @@ -106,7 +106,7 @@ There are no extra compiled components in `yolort` and package dependencies are
The models are also available via torch hub, to load `yolov5s` with pretrained weights simply do:

```python
model = torch.hub.load("zhiqwang/yolov5-rt-stack:main", "yolov5s", pretrained=True)
model = torch.hub.load("zhiqwang/yolort:main", "yolov5s", pretrained=True)
```

### Loading checkpoint from official yolov5
Expand Down Expand Up @@ -177,7 +177,7 @@ Now, `yolort` can draw the model graph directly, checkout our [tutorial](https:/

We love your input! Please see our [Contributing Guide](.github/CONTRIBUTING.md) to get started and for how to help out. Thank you to all our contributors! If you like this project please consider ⭐ this repo, as it is the simplest way to support us.

[![Contributors](https://contrib.rocks/image?repo=zhiqwang/yolov5-rt-stack)](https://github.com/zhiqwang/yolov5-rt-stack/graphs/contributors)
[![Contributors](https://contrib.rocks/image?repo=zhiqwang/yolort)](https://github.com/zhiqwang/yolort/graphs/contributors)

## 📖 Citing yolort

Expand All @@ -187,7 +187,7 @@ If you use yolort in your publication, please cite it by using the following Bib
@Misc{yolort2021,
author = {Zhiqiang Wang and Song Lin and Shiquan Yu and Wei Zeng and Fidan Kharrasov},
title = {YOLORT: A runtime stack for object detection on specialized accelerators},
howpublished = {\url{https://github.com/zhiqwang/yolov5-rt-stack}},
howpublished = {\url{https://github.com/zhiqwang/yolort}},
year = {2021}
}
```
Expand Down
4 changes: 2 additions & 2 deletions deployment/tensorrt-yolov6/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
1. 下载 yolort 源码:

```sh
git clone https://github.com/zhiqwang/yolov5-rt-stack.git
cd yolov5-rt-stack/deployment/tensorrt-yolov6
git clone https://github.com/zhiqwang/yolort.git
cd yolort/deployment/tensorrt-yolov6
```

1. 导出 ONNX 的时候请务必包含 EfficientNMS 算子, 稍后我们会加入一个更清晰的流程. ~从 YOLOv6 官方地址下载 ONNX 模型,如 [yolov6n.onnx](https://github.com/meituan/YOLOv6/releases/download/0.1.0/yolov6n.onnx)~.
Expand Down
2 changes: 1 addition & 1 deletion deployment/tensorrt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The TensorRT inference example of `yolort`.

## Usage

Here we will mainly discuss how to use the C++ interface, we recommend that you check out our [tutorial](https://zhiqwang.com/yolov5-rt-stack/notebooks/onnx-graphsurgeon-inference-tensorrt.html) first.
Here we will mainly discuss how to use the C++ interface, we recommend that you check out our [tutorial](https://zhiqwang.com/yolort/notebooks/onnx-graphsurgeon-inference-tensorrt.html) first.

1. Export your custom model to TensorRT format

Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ def setup(app):

nbsphinx_epilog = """
View this document as a notebook:
https://github.com/zhiqwang/yolov5-rt-stack/blob/main/{{ env.doc2path(env.docname, base=None) }}
https://github.com/zhiqwang/yolort/blob/main/{{ env.doc2path(env.docname, base=None) }}
----
"""
Expand All @@ -106,12 +106,12 @@ def setup(app):
# "google_analytics_account": "UA-XXXXX",
# Specify a base_url used to generate sitemap.xml. If not
# specified, then no sitemap will be built.
"base_url": "https://zhiqwang.com/yolov5-rt-stack",
"base_url": "https://zhiqwang.com/yolort",
# Set the color and the accent color
"color_primary": "blue",
"color_accent": "light-blue",
# Set the repo location to get a badge with stats
"repo_url": "https://github.com/zhiqwang/yolov5-rt-stack/",
"repo_url": "https://github.com/zhiqwang/yolort/",
"repo_name": "yolort",
# Visible levels of the global TOC; -1 means unlimited
"globaltoc_depth": 3,
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Read a source of image(s) and detect its objects:
And we support loading the trained weights from YOLOv5. Please see our documents on what
we `share`_ and how we `differ`_ from yolov5 for more details.

.. _share: https://zhiqwang.com/yolov5-rt-stack/notebooks/how-to-align-with-ultralytics-yolov5.html
.. _differ: https://zhiqwang.com/yolov5-rt-stack/notebooks/comparison-between-yolort-vs-yolov5.html
.. _share: https://zhiqwang.com/yolort/notebooks/how-to-align-with-ultralytics-yolov5.html
.. _differ: https://zhiqwang.com/yolort/notebooks/comparison-between-yolort-vs-yolov5.html

.. code:: python
Expand Down
4 changes: 2 additions & 2 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ install PyTorch 1.8.0+ and torchvision 0.9.0+.

To install yolort, you may either use the repository

https://github.com/zhiqwang/yolov5-rt-stack/
https://github.com/zhiqwang/yolort/

and ``setup.py`` from there or use

Expand All @@ -22,7 +22,7 @@ to get the latest release and

::

pip install 'git+https://github.com/zhiqwang/yolov5-rt-stack.git'
pip install 'git+https://github.com/zhiqwang/yolort.git'

to install the development version.

Expand Down
2 changes: 1 addition & 1 deletion notebooks/comparison-between-yolort-vs-yolov5.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"\n",
"For pre-processing, YOLOv5 uses the [letterboxing (padding)](https://en.wikipedia.org/wiki/Letterboxing_(filming)) resizing that maintains the aspect ratio. The error arises from the `interpolate` operator used in resizing. YOLOv5 uses the [cv2.resize](https://docs.opencv.org/4.x/da/d54/group__imgproc__transform.html#ga47a974309e9102f5f08231edc7e7529d) operator on the input `uint8 [0-255]` images, the operators in OpenCV are not traceable or scriptable, so we use [torch.nn.functional.interpolate](https://pytorch.org/docs/stable/generated/torch.nn.functional.interpolate.html#torch-nn-functional-interpolate) in yolort. Fortunately, the `interpolation` operator of PyTorch is [aligned](https://github.com/pytorch/vision/issues/2950#issuecomment-723038041) with that of OpenCV, however PyTorch's `interpolate` [only supports](https://github.com/pytorch/pytorch/issues/5580) the float data type now, we can only operate with images cast to float types, and therefore there will introduce some errors.\n",
"\n",
"YOLOv5 provides a very powerful function to do the post-processing, of which we implement only a non-agnostic version, but the accuracy here should be able to be consistent with the original version. See our [doc](https://zhiqwang.com/yolov5-rt-stack/notebooks/how-to-align-with-ultralytics-yolov5.html) for more details.\n",
"YOLOv5 provides a very powerful function to do the post-processing, of which we implement only a non-agnostic version, but the accuracy here should be able to be consistent with the original version. See our [doc](https://zhiqwang.com/yolort/notebooks/how-to-align-with-ultralytics-yolov5.html) for more details.\n",
"\n",
"## Prepare environment, image and model weights to test"
]
Expand Down
10 changes: 5 additions & 5 deletions notebooks/export-onnx-inference-onnxruntime.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -342,15 +342,15 @@
"text": [
"/opt/conda/lib/python3.8/site-packages/torch/nn/functional.py:3701: UserWarning: To copy construct from a tensor, it is recommended to use sourceTensor.clone().detach() or sourceTensor.clone().detach().requires_grad_(True), rather than torch.tensor(sourceTensor).\n",
" (torch.floor((input.size(i + 2).float() * torch.tensor(scale_factors[i], dtype=torch.float32)).float()))\n",
"/coding/yolov5-rt-stack/yolort/models/transform.py:282: TracerWarning: Iterating over a tensor might cause the trace to be incorrect. Passing a tensor of different shape won't change the number of iterations executed (and might lead to errors or silently give incorrect results).\n",
"/coding/yolort/yolort/models/transform.py:282: TracerWarning: Iterating over a tensor might cause the trace to be incorrect. Passing a tensor of different shape won't change the number of iterations executed (and might lead to errors or silently give incorrect results).\n",
" img_h, img_w = _get_shape_onnx(img)\n",
"/coding/yolov5-rt-stack/yolort/models/anchor_utils.py:45: TracerWarning: torch.as_tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.\n",
"/coding/yolort/yolort/models/anchor_utils.py:45: TracerWarning: torch.as_tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.\n",
" anchors = torch.as_tensor(self.anchor_grids, dtype=torch.float32, device=device).to(dtype=dtype)\n",
"/coding/yolov5-rt-stack/yolort/models/anchor_utils.py:46: TracerWarning: torch.as_tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.\n",
"/coding/yolort/yolort/models/anchor_utils.py:46: TracerWarning: torch.as_tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.\n",
" strides = torch.as_tensor(self.strides, dtype=torch.float32, device=device).to(dtype=dtype)\n",
"/coding/yolov5-rt-stack/yolort/models/box_head.py:402: TracerWarning: torch.as_tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.\n",
"/coding/yolort/yolort/models/box_head.py:402: TracerWarning: torch.as_tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.\n",
" strides = torch.as_tensor(self.strides, dtype=torch.float32, device=device).to(dtype=dtype)\n",
"/coding/yolov5-rt-stack/yolort/models/box_head.py:333: TracerWarning: Iterating over a tensor might cause the trace to be incorrect. Passing a tensor of different shape won't change the number of iterations executed (and might lead to errors or silently give incorrect results).\n",
"/coding/yolort/yolort/models/box_head.py:333: TracerWarning: Iterating over a tensor might cause the trace to be incorrect. Passing a tensor of different shape won't change the number of iterations executed (and might lead to errors or silently give incorrect results).\n",
" for head_output, grid, shift, stride in zip(head_outputs, grids, shifts, strides):\n",
"/opt/conda/lib/python3.8/site-packages/torch/onnx/symbolic_opset9.py:2815: UserWarning: Exporting aten::index operator of advanced indexing in opset 11 is achieved by combination of multiple ONNX operators, including Reshape, Transpose, Concat, and Gather. If indices include negative values, the exported graph will produce incorrect results.\n",
" warnings.warn(\"Exporting aten::index operator of advanced indexing in opset \" +\n"
Expand Down
Loading

0 comments on commit 672ae82

Please sign in to comment.