Skip to content

Commit

Permalink
Add Colab Tutorial (open-mmlab#7)
Browse files Browse the repository at this point in the history
* add badge

* Created using Colaboratory

* add read docs

* Fixed readthedocs

* fixed colab ref

* add readthedocs.txt

* add link

* fixed modelzoo link

* add missing reference

* fixed docs

* remove relative path in docs

* add colab in README.md

* update docker image

* add newline

* fixed br
  • Loading branch information
xvjiarui authored Jul 10, 2020
1 parent b2724da commit 6c6330f
Show file tree
Hide file tree
Showing 13 changed files with 1,485 additions and 35 deletions.
7 changes: 7 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2

python:
version: 3.7
install:
- requirements: requirements/docs.txt
- requirements: requirements/readthedocs.txt
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<div align="center">
<img src="resources/mmseg-logo.png" width="600"/>
</div>
<br />

[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmsegmentation.readthedocs.io/en/latest/)
[![badge](https://github.com/open-mmlab/mmsegmentation/workflows/build/badge.svg)](https://github.com/open-mmlab/mmsegmentation/actions)
[![codecov](https://codecov.io/gh/open-mmlab/mmsegmentation/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmsegmentation)
[![license](https://img.shields.io/github/license/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/blob/master/LICENSE)

Documentation: https://mmsegmentation.readthedocs.io/

## Introduction

Expand Down Expand Up @@ -50,6 +58,7 @@ Supported methods:
- [x] [DeepLabV3+](configs/deeplabv3plus)
- [x] [UPerNet](configs/upernet)
- [x] [NonLocal Net](configs/nonlocal_net)
- [x] [EncNet](configs/encnet)
- [x] [CCNet](configs/ccnet)
- [x] [DANet](configs/danet)
- [x] [GCNet](configs/gcnet)
Expand All @@ -65,6 +74,8 @@ Please refer to [INSTALL.md](docs/install.md) for installation and dataset prepa
Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMSegmentation.
There are also tutorials for [adding new dataset](docs/tutorials/new_dataset.md), [designing data pipeline](docs/tutorials/data_pipeline.md), and [adding new modules](docs/tutorials/new_modules.md).

A Colab tutorial is also provided. You may preview the notebook [here](demo/MMSegmentation_Tutorial.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmsegmentation/blob/master/demo/MMSegmentation_Tutorial.ipynb) on Colab.

## Contributing

We appreciate all contributions to improve MMSegmentation. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.
Expand Down
Loading

0 comments on commit 6c6330f

Please sign in to comment.