Skip to content

Commit 4313dfc

Browse files
committed
[DOC] Update documentation
1 parent c551e9f commit 4313dfc

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

README.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. image:: ./docs/_images/badge_small.png
22

3-
|github|_ |readthedocs|_ |codecov|_ |python|_
3+
|github|_ |readthedocs|_ |codecov|_ |python|_ |license|_
44

55
.. |github| image:: https://github.com/xuyxu/Ensemble-Pytorch/workflows/torchensemble-CI/badge.svg
66
.. _github: https://github.com/xuyxu/Ensemble-Pytorch/actions
@@ -14,6 +14,9 @@
1414
.. |python| image:: https://img.shields.io/badge/python-3.6+-blue?logo=python
1515
.. _python: https://www.python.org/
1616

17+
.. |license| image:: https://img.shields.io/github/license/xuyxu/Ensemble-Pytorch
18+
.. _license: https://github.com/xuyxu/Ensemble-Pytorch/blob/master/LICENSE
19+
1720
Ensemble Pytorch
1821
================
1922

docs/index.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Ensemble-PyTorch Documentation
2-
==============================
1+
.. image:: ./_images/badge.png
2+
:align: center
3+
:width: 400
34

4-
|github|_ |readthedocs|_ |codecov|_ |python|_
5+
|github|_ |readthedocs|_ |codecov|_ |python|_ |license|_
56

67
.. |github| image:: https://github.com/xuyxu/Ensemble-Pytorch/workflows/torchensemble-CI/badge.svg
78
.. _github: https://github.com/xuyxu/Ensemble-Pytorch/actions
@@ -15,9 +16,11 @@ Ensemble-PyTorch Documentation
1516
.. |python| image:: https://img.shields.io/badge/python-3.6+-blue?logo=python
1617
.. _python: https://www.python.org/
1718

18-
.. image:: ./_images/badge.png
19-
:align: center
20-
:width: 400
19+
.. |license| image:: https://img.shields.io/github/license/xuyxu/Ensemble-Pytorch
20+
.. _license: https://github.com/xuyxu/Ensemble-Pytorch/blob/master/LICENSE
21+
22+
Ensemble-PyTorch Documentation
23+
==============================
2124

2225
Ensemble-PyTorch implements a collection of ensemble methods in PyTorch. It provides:
2326

@@ -30,7 +33,7 @@ To get started, please refer to `Quick Start <./quick_start.html>`__. To learn m
3033
This package is under active development. Please feel free to open an `issue <https://github.com/AaronX121/Ensemble-Pytorch/issues>`__ if your have any problem. In addition, any feature request or `pull request <https://github.com/AaronX121/Ensemble-Pytorch/pulls>`__ would be highly welcomed.
3134

3235
.. toctree::
33-
:maxdepth: 2
36+
:maxdepth: 1
3437

3538
Quick Start <quick_start>
3639
Introduction <introduction>

0 commit comments

Comments
 (0)