Skip to content

Commit

Permalink
add some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abhishekkrthakur committed Nov 7, 2021
1 parent 0753cc0 commit 3d7b7b8
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 1 deletion.
33 changes: 33 additions & 0 deletions docs/creating_env.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Creating an environment
===================================

An environment can be created using the `mlspace create` command.

For example, you can create a `torch` environment without GPU using:

.. code-block:: bash
$ mlspace create --name name_of_your_env --backend torch
and if you want to create an environment with GPU support, just add `--gpu` to the create command.


.. code-block:: bash
$ mlspace create --name name_of_your_env --backend torch --gpu
At any point, you can get help for a command using `--help`. E.g.

.. code-block:: bash
$ mlspace create --help
usage: mlspace <command> [<args>] create [-h] --name NAME --backend {torch} [--gpu]
optional arguments:
-h, --help show this help message and exit
--name NAME Name of MLSpace
--backend {torch} MLSpace backend
--gpu Whether to use GPU
34 changes: 33 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,40 @@
Welcome to MLSpace!
===================================

MLSpace is a no-hassle tool for data science, machine learning and deep learning.

MLSpace has pre-made environments for pytorch, tensorflow and everything else you might need.
All environments come with VSCode (code-server) and JupyterLab. You no longer need to care about CUDA/cuDNN versions!

Setting up MLSpace is a three step process:
- installation
- set up
- create and run environments

.. code-block:: bash
$ mlspace --help
usage: mlspace <command> [<args>]
positional arguments:
{create,setup,start,stop}
commands
create Create a new MLSpace
setup Setup MLSpace and install all dependencies. Run with `sudo`
start Start a new space
stop Stop a running MLSpace instance
optional arguments:
-h, --help show this help message and exit
--version, -v Display MLSpace version
For more information about a command, run: `mlspace <command> --help`
.. toctree::
:maxdepth: 2
:caption: Contents:

installation
installation
setting_up
creating_env
running_env
25 changes: 25 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,28 @@ If you already have `python` & `pip` installed on your system, you can just do:
$ pip install -U mlspace
If you do not have `python` and `pip` installed on your system, the first step would be to install them.

.. code-block:: bash
$ sudo apt-get update
$ sudo apt-get install -y python3 python3-pip
If you have multiple versions of python installed, you might want to update alternatives and point `python`
command to a particular version.


.. code-block:: bash
$ sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 1
$ sudo update-alternatives --install /usr/bin/pip pip /usr/bin/pip3 1
NOTE: MLSpace will work with any python >= 3.5!

Once `python` & `pip` are installed, you can now install `mlspace` using:


.. code-block:: bash
$ pip install -U mlspace
2 changes: 2 additions & 0 deletions docs/running_env.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Running an environment
===================================
10 changes: 10 additions & 0 deletions docs/setting_up.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Setup
===================================

To start the setup process run:

.. code-block:: bash
$ mlspace setup
Sit back, relax and let it install everything you will need :)

0 comments on commit 3d7b7b8

Please sign in to comment.