Merge pull request PaddlePaddle#8 from jerrywgz/update_readme

update README
WAYKEN-TSE · Jul 14, 2023 · 5a284e1 · 5a284e1
2 parents e8330eb + f13ee5b
commit 5a284e1
Show file tree

Hide file tree

Showing 5 changed files with 233 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,74 @@
+# Virtualenv
+/.venv/
+/venv/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+.ipynb_checkpoints/
+*.py[cod]
+
+# C extensions
+*.so
+
+# json file
+*.json
+
+# log file
+*.log
+
+# Distribution / packaging
+/bin/
+*build/
+/develop-eggs/
+*dist/
+/eggs/
+/lib/
+/lib64/
+/output/
+/inference_model/
+/output_inference/
+/parts/
+/sdist/
+/var/
+*.egg-info/
+/.installed.cfg
+/*.egg
+/.eggs
+
+# AUTHORS and ChangeLog will be generated while packaging
+/AUTHORS
+/ChangeLog
+
+# BCloud / BuildSubmitter
+/build_submitter.*
+/logger_client_log
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.tox/
+.coverage
+.cache
+.pytest_cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+
+# Sphinx documentation
+/docs/_build/
+
+*.tar
+*.pyc
+
+.idea/
+
+# NPU meta folder
+kernel_meta/
+
+# MAC
+*.DS_Store
+
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,44 @@
+-   repo: https://github.com/PaddlePaddle/mirrors-yapf.git
+    sha: 0d79c0c469bab64f7229c9aca2b1186ef47f0e37
+    hooks:
+    -   id: yapf
+        files: \.py$
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    sha: a11d9314b22d8f8c7556443875b731ef05965464
+    hooks:
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: detect-private-key
+        files: (?!.*paddle)^.*$
+    -   id: end-of-file-fixer
+        files: \.(md|yml)$
+    -   id: trailing-whitespace
+        files: \.(md|yml)$
+-   repo: https://github.com/Lucas-C/pre-commit-hooks
+    sha: v1.0.1
+    hooks:
+    -   id: forbid-crlf
+        files: \.(md|yml)$
+    -   id: remove-crlf
+        files: \.(md|yml)$
+    -   id: forbid-tabs
+        files: \.(md|yml)$
+    -   id: remove-tabs
+        files: \.(md|yml)$
+-   repo: local
+    hooks:
+    -   id: clang-format-with-version-check
+        name: clang-format
+        description: Format files with ClangFormat.
+        entry: bash ./.travis/codestyle/clang_format.hook -i
+        language: system
+        files: \.(c|cc|cxx|cpp|cu|h|hpp|hxx|proto)$
+
+-   repo: local
+    hooks:
+    -   id: cpplint-cpp-source
+        name: cpplint
+        description: Check C++ code style using cpplint.py.
+        entry: bash ./.travis/codestyle/cpplint_pre_commit.hook
+        language: system
+        files: \.(c|cc|cxx|cpp|cu|h|hpp|hxx)$
diff --git a/.style.yapf b/.style.yapf
@@ -0,0 +1,3 @@
+[style]
+based_on_style = pep8
+column_limit = 80
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,35 @@
+language: cpp
+cache: ccache
+sudo: required
+dist: trusty
+services:
+  - docker
+os:
+  - linux
+env:
+  - JOB=PRE_COMMIT
+
+addons:
+  apt:
+    packages:
+      - git
+      - python
+      - python-pip
+      - python2.7-dev
+  ssh_known_hosts: 13.229.163.131
+before_install:
+  - sudo pip install -U virtualenv pre-commit pip -i https://pypi.tuna.tsinghua.edu.cn/simple
+  - docker pull paddlepaddle/paddle:latest
+  - git pull https://github.com/PaddlePaddle/PaddleMIX develop
+
+script:
+  - exit_code=0
+  - .travis/precommit.sh || exit_code=$(( exit_code | $? ))
+  # - docker run -i --rm -v "$PWD:/py_unittest" paddlepaddle/paddle:latest /bin/bash -c
+  #   'cd /py_unittest; sh .travis/unittest.sh' || exit_code=$(( exit_code | $? ))
+  - if [ $exit_code -eq 0  ]; then true; else exit 1; fi;
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
diff --git a/README.md b/README.md
@@ -1 +1,77 @@
-# PaddleMIX
+<p align="center">
+  <img src="https://github.com/PaddlePaddle/PaddleMIX/assets/22989727/2cd19298-1c52-4d73-a0f7-dcdab6a8ec90" align="middle" width = "600" />
+</p>
+
+<p align="center">
+    <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-dfd.svg"></a>
+    <a href=""><img src="https://img.shields.io/badge/python-3.7+-aff.svg"></a>
+    <a href=""><img src="https://img.shields.io/badge/os-linux%2C%20win%2C%20mac-pink.svg"></a>
+    <a href="https://github.com/PaddlePaddle/PaddleMIX/stargazers"><img src="https://img.shields.io/github/stars/PaddlePaddle/PaddleMIX?color=ccf"></a>
+</p>
+</div>
+
+## 简介
+
+PaddleMIX是基于飞桨的跨模态大模型开发套件，聚合图像、文本、视频等多种模态，覆盖视觉语言预训练，文生图，文生视频等丰富的跨模态任务。提供开箱即用的开发体验，同时满足开发者灵活定制需求，探索通用人工智能。
+
+## 最新进展
+
+**2023.7.31 发布 PaddleMIX v0.1**
+* 首次发布PaddleMIX跨模态大模型开发套件，融合PPdiffuser多模态扩散模型工具箱能力，广泛支持PaddleNLP大语言模型
+* 新增EVA-CLIP，BLIP-2，miniGPT-4，Stable Diffusion，ControlNet等xx个跨模态大模型
+
+## 主要特性
+
+- **丰富的多模态功能:** 覆盖图文预训练，文生图，跨模态视觉任务，实现图像编辑、数据标注、数据清理等多样功能
+- **简洁的开发体验:** 模型统一开发接口，高效实现自定义模型开发和功能实现
+- **高效的训推流程:** 全量模型打通训练推理一站式开发流程，BLIP-2，Stable Diffusion等重点模型训推性能达到业界领先
+- **超大规模训练支持:** 可训练千亿规模图文预训练模型，百亿规模文生图底座模型
+
+## 任务展示
+
+1. 图像描述（Image Caption）
+2. 文图生成（Text-to-Image Generation）
+3. 文本引导的图像编辑（Text-Guided Image Inpainting）
+
+## 安装
+
+1. 环境依赖
+```
+pip install -r requirements.txt
+```
+
+关于PaddlePaddle安装的详细教程请查看[Installation](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/develop/install/pip/linux-pip.html)。
+
+2. 手动安装
+```
+git clone https://github.com/PaddlePaddle/PaddleMIX
+cd PaddleMIX
+pip install -e .
+```
+
+## 教程
+
+- 快速开始
+- API文档
+- 训练微调
+- 推理部署
+
+## 特色应用
+
+1. 二维码模型
+2. Generative FIll
+3. Mix叠图
+
+## 模型库
+
+<table align="center">
+  <tbody>
+    <tr align="center" valign="center">
+      <td>
+        <b>视觉语言模型（paddlevlp）</b>
+      </td>
+      <td>
+
+## 许可证书
+
+本项目的发布受Apache 2.0 license许可认证。