Browse Source

docs: add example readme

chore: gitignore
master
KSkun 3 years ago
commit
79dfcf7f01
2 changed files with 72 additions and 0 deletions
  1. +2
    -0
      .gitignore
  2. +70
    -0
      README.md

+ 2
- 0
.gitignore View File

@@ -0,0 +1,2 @@
.idea/
*.png

+ 70
- 0
README.md View File

@@ -0,0 +1,70 @@
# Jittor 武汉大学队 手写数字生成

![主要结果](https://s3.bmp.ovh/imgs/2022/04/19/440f015864695c92.png)

|展示方法的流程特点或者主要结果等

## 简介
| 简单介绍项目背景、项目特点

本项目包含了第二届计图挑战赛计图 - 草图生成风景比赛的代码实现。本项目的特点是:采用了 XX 方法对 YY 处理,取得了 ZZ 的效果。

## 安装
| 介绍基本的硬件需求、运行环境、依赖安装方法

本项目可在 2 张 2080 上运行,训练时间约为 6 小时。

#### 运行环境
- ubuntu 20.04 LTS
- python >= 3.7
- jittor >= 1.3.0

#### 安装依赖
执行以下命令安装 python 依赖
```
pip install -r requirements.txt
```

#### 预训练模型
预训练模型模型下载地址为 https:abc.def.gh,下载后放入目录 `<root>/weights/` 下。

## 数据预处理
| 介绍数据预处理方法,可选

将数据下载解压到 `<root>/data` 下,执行以下命令对数据预处理:
```
bash scripts/prepross.sh
```

## 训练
| 介绍模型训练的方法

单卡训练可运行以下命令:
```
bash scripts/train.sh
```

多卡训练可以运行以下命令:
```
bash scripts/train-multigpu.sh
```

## 推理
| 介绍模型推理、测试、或者评估的方法

生成测试集上的结果可以运行以下命令:

```
bash scripts/test.sh
```

## 致谢
| 对参考的论文、开源库予以致谢,可选

此项目基于论文 *A Style-Based Generator Architecture for Generative Adversarial Networks* 实现,部分代码参考了 [jittor-gan](https://github.com/Jittor/gan-jittor)。

## 注意事项

点击项目的“设置”,在Description一栏中添加项目描述,需要包含“jittor”字样。同时在Topics中需要添加jittor。

![image-20220419164035639](https://s3.bmp.ovh/imgs/2022/04/19/6a3aa627eab5f159.png)

Loading…
Cancel
Save