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

[Enhancement] Refactor main page readme. #1609

Merged
merged 43 commits into from
Feb 21, 2023
Merged
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
69a2207
add backtotop and move demos to back
liuwenran Jan 16, 2023
97a5314
add intro image
liuwenran Jan 17, 2023
5e1fbb5
fix intro
liuwenran Jan 17, 2023
49fe493
test table
liuwenran Jan 17, 2023
a48c5e0
refact model zoo
liuwenran Jan 17, 2023
7d96426
fix image size.
liuwenran Jan 17, 2023
f865a37
fix model zoo.
liuwenran Jan 17, 2023
b01700c
put text-to-image ahead
liuwenran Jan 17, 2023
4b5cb79
add top id
liuwenran Jan 17, 2023
51009a8
remove intro back to top
liuwenran Jan 17, 2023
3c06806
whats new
liuwenran Jan 17, 2023
60ee358
whats new update
liuwenran Jan 17, 2023
6901aac
fix whats new
liuwenran Jan 17, 2023
0c56f96
major features.
liuwenran Jan 17, 2023
82fcbc0
add demos
liuwenran Jan 17, 2023
e4f49ff
fix demos.
liuwenran Jan 17, 2023
a428978
put whats new ahead
liuwenran Jan 17, 2023
cfd5f99
fix image colorization
liuwenran Jan 17, 2023
407ee79
Merge branch 'dev-1.x' into refact-readme
liuwenran Jan 17, 2023
a94df20
pre commit
liuwenran Jan 17, 2023
bb49978
Merge branch 'refact-readme' of https://github.com/liuwenran/mmeditin…
liuwenran Jan 17, 2023
846e70f
Merge branch 'dev-1.x' into refact-readme
liuwenran Jan 18, 2023
32bd988
remove getting started and demos.
liuwenran Jan 18, 2023
29fe7ab
add migration.
liuwenran Jan 18, 2023
36a5354
add contributors graph
liuwenran Jan 19, 2023
5456974
Merge branch 'dev-1.x' into refact-readme
liuwenran Jan 19, 2023
f97dc1b
contributing
liuwenran Jan 19, 2023
2b61d07
major features.
liuwenran Jan 19, 2023
7c4bb3c
use video in intro.
liuwenran Jan 19, 2023
a035792
fix whats new
liuwenran Jan 19, 2023
06f3895
change video
liuwenran Jan 29, 2023
a957a4e
change video sr and video interpolation intro
liuwenran Jan 29, 2023
0a3e251
Merge branch 'dev-1.x' into refact-readme
liuwenran Jan 31, 2023
2f9af80
update intro video
liuwenran Feb 7, 2023
e422369
Merge branch 'refact-readme' of https://github.com/liuwenran/mmeditin…
liuwenran Feb 7, 2023
07c5576
add emoji
liuwenran Feb 13, 2023
29bfbbe
fix backto top
liuwenran Feb 13, 2023
14c2109
add emoji major feature
liuwenran Feb 13, 2023
9448d75
Merge branch 'dev-1.x' into refact-readme
liuwenran Feb 16, 2023
bdbdbb3
fix failed link
liuwenran Feb 16, 2023
89822c1
add top emoji back
liuwenran Feb 16, 2023
d6aa1a2
combine sngan and proj gan
liuwenran Feb 21, 2023
d4ae48c
Merge branch 'dev-1.x' into refact-readme
zengyh1900 Feb 21, 2023
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
Next Next commit
add backtotop and move demos to back
  • Loading branch information
liuwenran committed Jan 16, 2023
commit 69a220703429518fa0195cd292915e1280f6cf94
111 changes: 74 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,32 @@
[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/issues)
[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/issues)

[📘Documentation](https://mmediting.readthedocs.io/en/1.x/) |
[🛠️Installation](https://mmediting.readthedocs.io/en/1.x/2_get_started.html#installation) |
[👀Model Zoo](https://mmediting.readthedocs.io/en/1.x/3_model_zoo.html) |
[🆕Update News](docs/en/changelog.md) |
[🚀Ongoing Projects](https://github.com/open-mmlab/mmediting/projects) |
[🤔Reporting Issues](https://github.com/open-mmlab/mmediting/issues)
[Documentation](https://mmediting.readthedocs.io/en/1.x/) |
[Installation](https://mmediting.readthedocs.io/en/1.x/2_get_started.html#installation) |
[Model Zoo](https://mmediting.readthedocs.io/en/1.x/3_model_zoo.html) |
[Update News](docs/en/changelog.md) |
[Ongoing Projects](https://github.com/open-mmlab/mmediting/projects) |
[Reporting Issues](https://github.com/open-mmlab/mmediting/issues)

English | [简体中文](README_zh-CN.md)

</div>

## Table of Contents
- [Introduction](#introduction)
- [What's New](#whats-new)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Model Zoo](#model-zoo)
- [Demos](#demos)
- [Contributing](#contributing)
- [Acknowledgement](#acknowledgement)
- [Citation](#citation)
- [License](#license)
- [Projects in OpenMMLab 2.0](#projects-in-openmmlab-20)

<p align="right"><a href="#top">Back to top</a></p>

## Introduction

MMEditing is an open-source image and video editing&generating toolbox based on PyTorch. It is a part of the [OpenMMLab](https://openmmlab.com/) project.
Expand All @@ -49,37 +64,6 @@ Currently, MMEditing support the following tasks:

The master branch works with **PyTorch 1.5+**.

Some Demos:

https://user-images.githubusercontent.com/12756472/158972852-be5849aa-846b-41a8-8687-da5dee968ac7.mp4

https://user-images.githubusercontent.com/12756472/158972813-d8d0f19c-f49c-4618-9967-52652726ef19.mp4

<table align="center">
<thead>
<tr>
<td>
<div align="center">
<b> GAN Interpolation</b>
<br/>
<img src="https://user-images.githubusercontent.com/12726765/114679300-9fd4f900-9d3e-11eb-8f37-c36a018c02f7.gif" width="200"/>
</div></td>
<td>
<div align="center">
<b> GAN Projector</b>
<br/>
<img src="https://user-images.githubusercontent.com/12726765/114524392-c11ee200-9c77-11eb-8b6d-37bc637f5626.gif" width="200"/>
</div></td>
<td>
<div align="center">
<b> GAN Manipulation</b>
<br/>
<img src="https://user-images.githubusercontent.com/12726765/114523716-20302700-9c77-11eb-804e-327ae1ca0c5b.gif" width="200"/>
</div></td>
</tr>
</thead>
</table>

### Major features

- **Modular design**
Expand All @@ -102,6 +86,8 @@ Note that **MMSR** has been merged into this repo, as a part of MMEditing.
With elaborate designs of the new framework and careful implementations,
hope MMEditing could provide better experience.

<p align="right"><a href="#top">Back to top</a></p>

## What's New

### 🌟 Preview of 1.x version
Expand Down Expand Up @@ -129,6 +115,8 @@ Find more new features in [1.x branch](https://github.com/open-mmlab/mmediting/t

Please refer to [changelog.md](docs/en/changelog.md) for details and release history.

<p align="right"><a href="#top">Back to top</a></p>

## Installation

MMEditing depends on [PyTorch](https://pytorch.org/), [MMEngine](https://github.com/open-mmlab/mmengine) and [MMCV](https://github.com/open-mmlab/mmcv).
Expand Down Expand Up @@ -157,10 +145,14 @@ pip3 install -e .

Please refer to [installation](docs/en/get_started/install.md) for more detailed instruction.

<p align="right"><a href="#top">Back to top</a></p>

## Getting Started

Please see [quick run](docs/en/get_started/quick_run.md) and [inference](docs/en/user_guides/inference.md) for the basic usage of MMEditing.

<p align="right"><a href="#top">Back to top</a></p>

## Model Zoo

Supported algorithms:
Expand Down Expand Up @@ -298,14 +290,53 @@ Supported algorithms:

Please refer to [model_zoo](https://mmediting.readthedocs.io/en/1.x/3_model_zoo.html) for more details.

<p align="right"><a href="#top">Back to top</a></p>

## Demos:

https://user-images.githubusercontent.com/12756472/158972852-be5849aa-846b-41a8-8687-da5dee968ac7.mp4

https://user-images.githubusercontent.com/12756472/158972813-d8d0f19c-f49c-4618-9967-52652726ef19.mp4

<table align="center">
<thead>
<tr>
<td>
<div align="center">
<b> GAN Interpolation</b>
<br/>
<img src="https://user-images.githubusercontent.com/12726765/114679300-9fd4f900-9d3e-11eb-8f37-c36a018c02f7.gif" width="200"/>
</div></td>
<td>
<div align="center">
<b> GAN Projector</b>
<br/>
<img src="https://user-images.githubusercontent.com/12726765/114524392-c11ee200-9c77-11eb-8b6d-37bc637f5626.gif" width="200"/>
</div></td>
<td>
<div align="center">
<b> GAN Manipulation</b>
<br/>
<img src="https://user-images.githubusercontent.com/12726765/114523716-20302700-9c77-11eb-804e-327ae1ca0c5b.gif" width="200"/>
</div></td>
</tr>
</thead>
</table>

<p align="right"><a href="#top">Back to top</a></p>

## Contributing

We appreciate all contributions to improve MMEditing. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmcv/tree/2.x/CONTRIBUTING.md) in MMCV and [CONTRIBUTING.md](https://github.com/open-mmlab/mmengine/blob/main/CONTRIBUTING.md) in MMEngine for more details about the contributing guideline.

<p align="right"><a href="#top">Back to top</a></p>

## Acknowledgement

MMEditing is an open source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new methods.

<p align="right"><a href="#top">Back to top</a></p>

## Citation

If MMEditing is helpful to your research, please cite it as below.
Expand All @@ -319,11 +350,15 @@ If MMEditing is helpful to your research, please cite it as below.
}
```

<p align="right"><a href="#top">Back to top</a></p>

## License

This project is released under the [Apache 2.0 license](LICENSE).
Please refer to [LICENSES](LICENSE) for the careful check, if you are using our code for commercial matters.

<p align="right"><a href="#top">Back to top</a></p>

## Projects in OpenMMLab 2.0

- [MMEngine](https://github.com/open-mmlab/mmengine): OpenMMLab foundational library for training deep learning models.
Expand All @@ -346,3 +381,5 @@ Please refer to [LICENSES](LICENSE) for the careful check, if you are using our
- [MMEditing](https://github.com/open-mmlab/mmediting/tree/1.x): OpenMMLab image and video editing toolbox.
- [MMGeneration](https://github.com/open-mmlab/mmgeneration/tree/1.x): OpenMMLab image and video generative models toolbox.
- [MMDeploy](https://github.com/open-mmlab/mmdeploy): OpenMMLab model deployment framework.

<p align="right"><a href="#top">Back to top</a></p>