Skip to content

Commit

Permalink
[Docs] Add Install on Google Colab (#145)
Browse files Browse the repository at this point in the history
  • Loading branch information
MeowZheng authored May 31, 2022
1 parent 7fb24c4 commit 298b3bb
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/en/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,38 @@ If you try to train/test/inference a model containing above ops, an error will b
| :---------: | :--------------------------------------------------------------------------: |
| Correlation | PWC-Net, FlowNetC, FlowNet2, IRR-PWC, LiteFlowNet, LiteFlowNet2, MaskFlowNet |

### Install on Google Colab

[Google Colab](https://research.google.com/) usually has PyTorch installed,
thus we only need to install MMCV and MMFlow with the following commands.

**Step 1.** Install [MMCV](https://github.com/open-mmlab/mmcv) using [MIM](https://github.com/open-mmlab/mim).

```shell
!pip3 install openmim
!mim install mmcv-full

This comment has been minimized.

Copy link
@hoseinCode

hoseinCode Sep 11, 2023

hi in command !mim install mmcv-full , colab processes a lot of time and show Building wheels for collected packages: mmcv-full in output. not error not progress successfully

```

**Step 2.** Install MMFlow from the source.

```shell
!git clone https://github.com/open-mmlab/mmflow.git
%cd mmflow
!pip install -e .
```

**Step 3.** Verification.

```python
import mmflow
print(mmflow.__version__)
# Example output: 0.4.1
```

```{note}
Within Jupyter, the exclamation mark `!` is used to call external executables and `%cd` is a [magic command](https://ipython.readthedocs.io/en/stable/interactive/magics.html#magic-cd) to change the current working directory of Python.
```

### Using MMFlow with Docker

We provide a [Dockerfile](https://github.com/open-mmlab/mmflow/blob/master/docker/Dockerfile) to build an image. Ensure that your [docker version](https://docs.docker.com/engine/install/) >=19.03.
Expand Down

1 comment on commit 298b3bb

@hoseinCode
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi i did above steps for installing MMFlow in google colab, but colab show error message:
6 #!pip install -e
7
----> 8 import mmflow
9 print(mmflow.version)
10

ModuleNotFoundError: No module named 'mmflow'
please help me

Please sign in to comment.