Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Translate data_transform.md to English #2325

Merged
merged 22 commits into from
Oct 20, 2022
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
b84c5de
draft 1 with some typo fixed
xin-li-67 Oct 10, 2022
17f5521
draft 2
xin-li-67 Oct 10, 2022
a9552cd
Merge branch '2.x' of github.com:open-mmlab/mmcv into data_transform_en
xin-li-67 Oct 11, 2022
2bc5aa7
Update docs/en/understand_mmcv/data_process.md
xin-li-67 Oct 11, 2022
0ce7d72
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
4011155
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
caf28a3
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
d5fc94b
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
9b5f421
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
f26fc36
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
53f5696
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
9c64faa
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 11, 2022
28b4808
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 19, 2022
e25af87
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 19, 2022
b1dfa00
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 19, 2022
714ac51
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 19, 2022
f85a616
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 19, 2022
c593fee
Remove timer tool
xin-li-67 Oct 19, 2022
39aaa18
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 20, 2022
c1b35dd
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 20, 2022
6f6f48f
Update docs/en/understand_mmcv/data_transform.md
xin-li-67 Oct 20, 2022
4465b84
Update docs/en/understand_mmcv/data_transform.md
zhouzaida Oct 20, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/en/get_started/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Build on Linux or macOS

After cloning the repo with
Clone the repo with

```bash
git clone https://github.com/open-mmlab/mmcv.git
Expand All @@ -24,7 +24,7 @@ You can either
MMCV_WITH_OPS=0 pip install -e .
```

- install the full version
- or install the full version

```bash
pip install -e .
Expand Down
4 changes: 2 additions & 2 deletions docs/en/get_started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ research projects as below:
- [MMGeneration](https://github.com/open-mmlab/mmgeneration): OpenMMLab image and video generative models toolbox.
- [MMDeploy](https://github.com/open-mmlab/mmdeploy): OpenMMLab model deployment framework.

It provides the following functionalities.
It provides the following functionalities:

- Universal IO APIs
- Image/Video processing
- Image and annotation visualization
- Image transformation
- Useful developing tools (such as timer, etc)
xin-li-67 marked this conversation as resolved.
Show resolved Hide resolved
- Various CNN architectures
- High-quality implementation of common CUDA ops

Expand Down
6 changes: 3 additions & 3 deletions docs/en/understand_mmcv/cnn.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,15 @@ An example json file could be like:

The default links of the pre-trained models hosted on OpenMMLab AWS could be found [here](https://github.com/open-mmlab/mmcv/blob/master/mmcv/model_zoo/open_mmlab.json).

You may override default links by putting `open-mmlab.json` under `MMCV_HOME`. If `MMCV_HOME` is not find in the environment, `~/.cache/mmcv` will be used by default. You may `export MMCV_HOME=/your/path` to use your own path.
You may override default links by putting `open-mmlab.json` under `MMCV_HOME`. If `MMCV_HOME` is not found in your environment, `~/.cache/mmcv` will be used by default. You may use your own path with `export MMCV_HOME=/your/path`.

The external json files will be merged into default one. If the same key presents in both external json and default json, the external one will be used.

#### Load Checkpoint

The following types are supported for `filename` argument of `mmcv.load_checkpoint()`.
The following types are supported for `filename` of `mmcv.load_checkpoint()`.

- filepath: The filepath of the checkpoint.
- `http://xxx` and `https://xxx`: The link to download the checkpoint. The `SHA256` postfix should be contained in the filename.
- `torchvision://xxx`: The model links in `torchvision.models`.Please refer to [torchvision](https://pytorch.org/docs/stable/torchvision/models.html) for details.
- `torchvision://xxx`: The model links in `torchvision.models`. Please refer to [torchvision](https://pytorch.org/docs/stable/torchvision/models.html) for details.
- `open-mmlab://xxx`: The model links or filepath provided in default and additional json files.
8 changes: 4 additions & 4 deletions docs/en/understand_mmcv/data_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Image

This module provides some image processing methods, which requires `opencv` to be installed.
This module provides some image processing methods, which requires `opencv` to be installed first.

#### Read/Write/Show

Expand Down Expand Up @@ -118,7 +118,7 @@ mmcv.imflip(img, direction='vertical')

#### Crop

`imcrop` can crop the image with one or some regions, represented as (x1, y1, x2, y2).
`imcrop` can crop the image with one or more regions. Each region is represented by the upper left and lower right coordinates as (x1, y1, x2, y2).

```python
import mmcv
Expand All @@ -140,7 +140,7 @@ patches = mmcv.imcrop(img, bboxes, scale=1.2)

#### Padding

There are two methods `impad` and `impad_to_multiple` to pad an image to the
There are two methods, `impad` and `impad_to_multiple`, to pad an image to the
specific size with given values.

```python
Expand All @@ -165,7 +165,7 @@ img_ = mmcv.impad_to_multiple(img, 32)

### Video

This module provides the following functionalities.
This module provides the following functionalities:

- A `VideoReader` class with friendly apis to read and convert videos.
- Some methods for editing (cut, concat, resize) videos.
Expand Down
Loading