From 2c4516c62294964065d058d98799402f50afdef6 Mon Sep 17 00:00:00 2001
From: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Date: Wed, 6 Mar 2024 11:00:42 +0800
Subject: [PATCH] Add the supported pytorch versions in README (#1512)
---
README.md | 13 +++++++++++--
README_zh-CN.md | 13 +++++++++++--
2 files changed, 22 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index c2379cbfd8..7793d1a1cc 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,9 @@
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mmengine)](https://pypi.org/project/mmengine/)
+[![pytorch](https://img.shields.io/badge/pytorch-1.6~2.1-yellow)](#installation)
[![PyPI](https://img.shields.io/pypi/v/mmengine)](https://pypi.org/project/mmengine)
[![license](https://img.shields.io/github/license/open-mmlab/mmengine.svg)](https://github.com/open-mmlab/mmengine/blob/main/LICENSE)
-[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmengine.svg)](https://github.com/open-mmlab/mmengine/issues)
-[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmengine.svg)](https://github.com/open-mmlab/mmengine/issues)
[Introduction](#introduction) |
[Installation](#installation) |
@@ -97,6 +96,16 @@ MMEngine is a foundational library for training deep learning models based on Py
## Installation
+
+Supported PyTorch Versions
+
+| MMEngine | PyTorch | Python |
+| ------------------ | ------------ | -------------- |
+| main | >=1.6 \<=2.1 | >=3.8, \<=3.11 |
+| >=0.9.0, \<=0.10.3 | >=1.6 \<=2.1 | >=3.8, \<=3.11 |
+
+
+
Before installing MMEngine, please ensure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/get-started/locally/).
Install MMEngine
diff --git a/README_zh-CN.md b/README_zh-CN.md
index 171d66dac0..837401bdd2 100644
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -19,10 +19,9 @@
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mmengine)](https://pypi.org/project/mmengine/)
+[![pytorch](https://img.shields.io/badge/pytorch-1.6~2.1-yellow)](#安装)
[![PyPI](https://img.shields.io/pypi/v/mmengine)](https://pypi.org/project/mmengine)
[![license](https://img.shields.io/github/license/open-mmlab/mmengine.svg)](https://github.com/open-mmlab/mmengine/blob/main/LICENSE)
-[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmengine.svg)](https://github.com/open-mmlab/mmengine/issues)
-[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmengine.svg)](https://github.com/open-mmlab/mmengine/issues)
[简介](#简介) |
[安装](#安装) |
@@ -102,6 +101,16 @@ MMEngine 是一个基于 PyTorch 实现的,用于训练深度学习模型的
## 安装
+
+支持的 PyTorch 版本
+
+| MMEngine | PyTorch | Python |
+| ------------------ | ------------ | -------------- |
+| main | >=1.6 \<=2.1 | >=3.8, \<=3.11 |
+| >=0.9.0, \<=0.10.3 | >=1.6 \<=2.1 | >=3.8, \<=3.11 |
+
+
+
在安装 MMEngine 之前,请确保 PyTorch 已成功安装在环境中,可以参考 [PyTorch 官方安装文档](https://pytorch.org/get-started/locally/)。
安装 MMEngine