Merge pull request #16 from learning-at-home/update_readme-restyled

Restyle [WIP] Update README

README.md

@@ -2,40 +2,56 @@
 
 [![<ORG_NAME>](https://circleci.com/gh/learning-at-home/tesseract.svg?style=svg)](https://circleci.com/gh/learning-at-home/tesseract)
 
-
 Distributed training of large neural networks across volunteer computers.
 
 ![img](https://i.imgur.com/GPxolxb.gif)
 
-__[WIP]__ - this branch is in progress of updating. If you're interested in supplementary code for [Learning@home paper](https://arxiv.org/abs/2002.04013), you can find it at https://github.com/mryab/learning-at-home .
-
+**[WIP]** - this branch is in progress of updating. If you're interested in
+supplementary code for [Learning@home paper](https://arxiv.org/abs/2002.04013),
+you can find it at https://github.com/mryab/learning-at-home .
 
 ## What do I need to run it?
-* One or several computers, each equipped with at least one GPU
-* Each computer should have at least two open ports (if not, consider ssh port forwarding)
-* Some popular Linux x64 distribution
-  * Tested on Ubuntu16.04, should work fine on any popular linux64 and even MacOS;
-  * Running on Windows natively is not supported, please use vm or docker;
+
+- One or several computers, each equipped with at least one GPU
+- Each computer should have at least two open ports (if not, consider ssh port
+  forwarding)
+- Some popular Linux x64 distribution
+  - Tested on Ubuntu16.04, should work fine on any popular linux64 and even
+    MacOS;
+  - Running on Windows natively is not supported, please use vm or docker;
 
 ## How do I run it?
-Currently, there isn't any way to do it easily. There are some tests (you can look into CI logs and/or config) and we want to expand them, but if you want to do something complex with it, you're on your own.
 
+Currently, there isn't any way to do it easily. There are some tests (you can
+look into CI logs and/or config) and we want to expand them, but if you want to
+do something complex with it, you're on your own.
 
 ## tesseract quick tour
 
-__Trainer process:__
-  * __`RemoteExpert`__(`tesseract/client/remote_expert.py`) behaves like a pytorch module with autograd support but actually sends request to a remote runtime.
-  * __`GatingFunction`__(`tesseract/client/gating_function.py`) finds best experts for a given input and either returns them as `RemoteExpert` or applies them right away.
+**Trainer process:**
+
+- **`RemoteExpert`**(`tesseract/client/remote_expert.py`) behaves like a pytorch
+  module with autograd support but actually sends request to a remote runtime.
+- **`GatingFunction`**(`tesseract/client/gating_function.py`) finds best experts
+  for a given input and either returns them as `RemoteExpert` or applies them
+  right away.
 
-__Runtime process:__
-  * __`TesseractRuntime`__ (`tesseract/runtime/__init__.py`) aggregates batches and performs inference/training of experts according to their priority. 
-  * __`TesseractServer`__ (`tesseract/server/__init__.py`) wraps runtime and periodically uploads experts into `TesseractNetwork`.
+**Runtime process:**
 
-__DHT:__
-   * __`TesseractNetwork`__(`tesseract/network/__init__.py`) is a node of Kademlia-based DHT that stores metadata used by trainer and runtime.
+- **`TesseractRuntime`** (`tesseract/runtime/__init__.py`) aggregates batches
+  and performs inference/training of experts according to their priority.
+- **`TesseractServer`** (`tesseract/server/__init__.py`) wraps runtime and
+  periodically uploads experts into `TesseractNetwork`.
+
+**DHT:**
+
+- **`TesseractNetwork`**(`tesseract/network/__init__.py`) is a node of
+  Kademlia-based DHT that stores metadata used by trainer and runtime.
 
 ## Limitations
-__DHT__:
+
+**DHT**:
 
 - DHT functionality is severely limited by its inability to traverse NAT.
-- Because of this all the features that require DHT are in deep pre-alpha state and cannot be used without special setup.
+- Because of this all the features that require DHT are in deep pre-alpha state
+  and cannot be used without special setup.