Skip to content
This repository has been archived by the owner on Jul 2, 2021. It is now read-only.

Improve the top page of the documentation #470

Merged
merged 2 commits into from
Nov 29, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 3 additions & 49 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,58 +5,12 @@ ChainerCV

ChainerCV is a **deep learning based computer vision library** built on top of `Chainer <https://github.com/chainer/chainer/>`_.


Install Guide
=============

Pip
~~~

You can install ChainerCV using `pip`.

.. code-block:: shell

pip install -U numpy
pip install chainercv


Anaconda
~~~~~~~~

Build instruction using Anaconda is as follows.

.. code-block:: shell

# For python 3
# wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh

bash miniconda.sh -b -p $HOME/miniconda
export PATH="$HOME/miniconda/bin:$PATH"
conda config --set always_yes yes --set changeps1 no
conda update -q conda

# Download ChainerCV and go to the root directory of ChainerCV
git clone https://github.com/chainer/chainercv
cd chainercv
conda env create -f environment.yml
source activate chainercv

# Install ChainerCV
pip install -e .

# Try our demos at examples/* !


Reference Manual
================

.. toctree::
:maxdepth: 3
:maxdepth: 1

reference/index
install
tutorial/index

reference/index


Indices and tables
Expand Down
41 changes: 41 additions & 0 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Installation Guide
==================

Pip
~~~

You can install ChainerCV using `pip`.

.. code-block:: shell

pip install -U numpy
pip install chainercv


Anaconda
~~~~~~~~

Build instruction using Anaconda is as follows.

.. code-block:: shell

# For python 3
# wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh

bash miniconda.sh -b -p $HOME/miniconda
export PATH="$HOME/miniconda/bin:$PATH"
conda config --set always_yes yes --set changeps1 no
conda update -q conda

# Download ChainerCV and go to the root directory of ChainerCV
git clone https://github.com/chainer/chainercv
cd chainercv
conda env create -f environment.yml
source activate chainercv

# Install ChainerCV
pip install -e .

# Try our demos at examples/* !