docs: small modify

guofei9987 · Mar 13, 2021 · c986f45 · c986f45
1 parent 17af178
commit c986f45
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -458,7 +458,7 @@ print(best_x, best_y)
 ```
 
 
-## Projects using scikit-opt
+# Projects using scikit-opt
 
 
 - [Heinrich, K., Zschech, P., Janiesch, C., & Bonin, M. (2021). Process data properties matter: Introducing gated convolutional neural networks (GCNN) and key-value-predict attention networks (KVP) for next event prediction with deep learning. Decision Support Systems, 113494.](https://www.sciencedirect.com/science/article/pii/S016792362100004X)

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -438,7 +438,7 @@ print(best_x, best_y)
 ```
 
 
-## Projects using scikit-opt
+# Projects using scikit-opt
 
 
 - [Heinrich, K., Zschech, P., Janiesch, C., & Bonin, M. (2021). Process data properties matter: Introducing gated convolutional neural networks (GCNN) and key-value-predict attention networks (KVP) for next event prediction with deep learning. Decision Support Systems, 113494.](https://www.sciencedirect.com/science/article/pii/S016792362100004X)

diff --git a/docs/en/_coverpage.md b/docs/en/_coverpage.md
@@ -4,12 +4,16 @@
 
 > Powerful Python module for Heuristic Algorithms
 
-* Differential Evolution
-* Genetic Algorithm
-* Particle Swarm Optimization
-* Simulated Annealing
-* Ant Colony Algorithm
-* Immune Algorithm
+* [![PyPI](https://img.shields.io/pypi/v/scikit-opt)](https://pypi.org/project/scikit-opt/)
+[![Build Status](https://travis-ci.com/guofei9987/scikit-opt.svg?branch=master)](https://travis-ci.com/guofei9987/scikit-opt)
+[![codecov](https://codecov.io/gh/guofei9987/scikit-opt/branch/master/graph/badge.svg)](https://codecov.io/gh/guofei9987/scikit-opt)
+[![License](https://img.shields.io/pypi/l/scikit-opt.svg)](https://github.com/guofei9987/scikit-opt/blob/master/LICENSE)
+![Python](https://img.shields.io/badge/python->=3.5-green.svg)
+![Platform](https://img.shields.io/badge/platform-windows%20|%20linux%20|%20macos-green.svg)
+[![Downloads](https://pepy.tech/badge/scikit-opt)](https://pepy.tech/project/scikit-opt)
+* Differential Evolution, Genetic Algorithm
+* Particle Swarm Optimization, Simulated Annealing
+* Ant Colony Algorithm, Immune Algorithm
 * Artificial Fish Swarm Algorithm
 
 [GitHub](https://github.com/guofei9987/scikit-opt/)

diff --git a/docs/en/speed_up.md b/docs/en/speed_up.md
@@ -79,8 +79,8 @@ print('parallel mode, time costs: ', (datetime.datetime.now() - start_time).tota
 ```
 
 output:
->common mode, time costs:  5.284991
-vector mode, time costs:  0.608695
+>common mode, time costs:  5.284991  
+vector mode, time costs:  0.608695  
 parallel mode, time costs:  1.114424
 
 To compare the speed of **common** and **cached**:
@@ -116,7 +116,7 @@ print('cache mode, time costs: ', (datetime.datetime.now() - start_time).total_s
 ```
 
 output:
->common mode, time costs:  6.29733
+>common mode, time costs:  6.29733  
 cache mode, time costs:  0.308823
 
 
diff --git a/docs/zh/README.md b/docs/zh/README.md
@@ -444,7 +444,7 @@ best_x, best_y = afsa.run()
 print(best_x, best_y)
 ```
 
-## 使用本项目的论文
+# 使用本项目的论文
 
 
 - [Heinrich, K., Zschech, P., Janiesch, C., & Bonin, M. (2021). Process data properties matter: Introducing gated convolutional neural networks (GCNN) and key-value-predict attention networks (KVP) for next event prediction with deep learning. Decision Support Systems, 113494.](https://www.sciencedirect.com/science/article/pii/S016792362100004X)

diff --git a/docs/zh/_coverpage.md b/docs/zh/_coverpage.md
@@ -4,13 +4,19 @@
 
 > 群体智能算法
 
-* 差分进化算法
-* 遗传算法
-* 粒子群算法
-* 模拟退火算法
-* 蚁群算法
-* 免疫优化算法
+* [![PyPI](https://img.shields.io/pypi/v/scikit-opt)](https://pypi.org/project/scikit-opt/)
+[![Build Status](https://travis-ci.com/guofei9987/scikit-opt.svg?branch=master)](https://travis-ci.com/guofei9987/scikit-opt)
+[![codecov](https://codecov.io/gh/guofei9987/scikit-opt/branch/master/graph/badge.svg)](https://codecov.io/gh/guofei9987/scikit-opt)
+[![License](https://img.shields.io/pypi/l/scikit-opt.svg)](https://github.com/guofei9987/scikit-opt/blob/master/LICENSE)
+![Python](https://img.shields.io/badge/python->=3.5-green.svg)
+![Platform](https://img.shields.io/badge/platform-windows%20|%20linux%20|%20macos-green.svg)
+[![Downloads](https://pepy.tech/badge/scikit-opt)](https://pepy.tech/project/scikit-opt)
+* 差分进化算法，遗传算法
+* 粒子群算法，模拟退火算法
+* 蚁群算法，免疫优化算法
 * 鱼群算法
 
 [GitHub](https://github.com/guofei9987/scikit-opt/)
 [开始](zh/README)
+
+
diff --git a/docs/zh/speed_up.md b/docs/zh/speed_up.md
@@ -74,8 +74,8 @@ print('parallel mode, time costs: ', (datetime.datetime.now() - start_time).tota
 ```
 
 output:
->common mode, time costs:  5.284991
-vector mode, time costs:  0.608695
+>common mode, time costs:  5.284991  
+vector mode, time costs:  0.608695  
 parallel mode, time costs:  1.114424
 
 
@@ -111,7 +111,7 @@ print('cache mode, time costs: ', (datetime.datetime.now() - start_time).total_s
 ```
 
 output:
->common mode, time costs:  6.29733
+>common mode, time costs:  6.29733  
 cache mode, time costs:  0.308823