Skip to content

Commit e819995

Browse files
committed
[DOC] Update docs on PyPI
1 parent cde06bc commit e819995

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

README.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ Ensemble Pytorch
2222

2323
Implementation of ensemble methods in Pytorch to boost the performance of your model.
2424

25+
News
26+
----
27+
28+
- The package has been uploaded to PyPI. You can now install it using ``pip install torchensemble``
29+
- A pre-released version of documentation is available at
30+
https://ensemble-pytorch.readthedocs.io/en/latest/
31+
2532
List of methods
2633
---------------
2734

@@ -41,12 +48,6 @@ List of methods
4148
| 6 | Adversarial Training | Parallel |
4249
+--------+----------------------+-------------------+
4350

44-
News
45-
----
46-
47-
- A pre-released version of documentation is available at
48-
https://ensemble-pytorch.readthedocs.io/en/latest/.
49-
5051
Installation
5152
------------
5253

docs/quick_start.rst

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
Get started
22
===========
33

4-
Install from Source
5-
-------------------
4+
Install the Stable Version
5+
--------------------------
66

7-
You can use the latest version of Ensemble-PyTorch with the following command:
7+
You can use the stable version of Ensemble-PyTorch with the following command:
88

99
.. code-block:: bash
1010
11-
$ git clone https://github.com/xuyxu/Ensemble-Pytorch.git
12-
$ cd Ensemble-Pytorch
13-
$ pip install -r requirements.txt
14-
$ python setup.py install
15-
16-
Ensemble-PyTorch is designed to be portable and has very small package dependencies. It is recommended to use the Python environment and PyTorch installed from `Anaconda <https://www.anaconda.com/>`__. In this case, there is no need to run the third command in the code snippet above.
11+
$ pip install torchensemble
1712
18-
.. tip::
19-
Ensemble-PyTorch is close to the end of the Beta stage. It will soon be uploaded to `PyPI <https://pypi.org/>`__.
13+
Ensemble-PyTorch is designed to be portable and has very small package dependencies. It is recommended to use the package environment and PyTorch installed from `Anaconda <https://www.anaconda.com/>`__.
2014

2115
Define Your Base Estimator
2216
--------------------------

0 commit comments

Comments
 (0)