You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 10, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: docs/guide_installation.rst
+11-17Lines changed: 11 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -3,33 +3,27 @@ Installation
3
3
4
4
You have multiple options to get up and running, though using ``pip`` is by far the easiest and most reliable.
5
5
6
+
A) Download Latest Release [Recommended]
7
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6
8
7
-
Downloading Package
8
-
-------------------
9
-
10
-
**Recommended.** To download and setup the last officially released package, you can do so from PYPI directly::
9
+
If you want to use the latest official release, you can do so from PYPI directly::
11
10
12
11
> pip install scikit-neuralnetwork
13
12
14
-
This contains its own packaged version of ``pylearn2`` from the date of the release (and tag) but will use any globally installed version if available.
15
-
16
-
If you want to install the very latest from source, please visit the `Project Page <http://github.com/aigamedev/scikit-neuralnetwork>`_ on GitHub for details.
13
+
This will install the latest official ``Lasagne`` and ``Theano`` as well as other minor packages too as a dependency. We strongly suggest you use a `virtualenv <https://virtualenv.pypa.io/en/latest/>`_ for Python.
17
14
15
+
B) Pulling Repositories [Optional]
16
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18
17
19
-
Pulling Repositories
20
-
--------------------
18
+
If you want to use the more advanced features like convolution, pooling or upscaling, these depend on the latest code from ``Lasagne`` and ``Theano`` master branches. You can install them manually as follows::
21
19
22
-
**Optional.** To setup a developer version of the project, you'll need to first install some dependencies manually. Unfortunately, ``pylearn2`` isn't yet installable via PyPI and recommends an editable (``pip -e``) installation::
> cd scikit-neuralnetwork; python setup.py develop
26
+
33
27
This will make the ``sknn`` package globally available within Python as a reference to the current directory.
34
28
35
29
@@ -45,4 +39,4 @@ Use the additional command-line parameters in the test runner ``--processes=8``
45
39
46
40
.. image:: console_tests.png
47
41
48
-
We strive to maintain 100% test coverage for all code-paths, to ensure that rapid changes in the underlying ``pylearn2`` library are caught automatically.
42
+
We strive to maintain 100% test coverage for all code-paths, to ensure that rapid changes in the underlying ``Lasagne`` and ``Theano`` libraries are caught automatically.
0 commit comments