add pics

Author: Alvant

topicnet/docs/images/doc_cluster__plot.png

@@ -1,27 +1,82 @@
-## Viewers 
+# Viewers
 
-Module ```viewers``` provides information from a topic model allowing to estimate the model quality. Its advantage is in unified call ifrastucture to the topic model making the routine and tedious task of extracting the information easy.
+Module `viewers` provides information from a topic model allowing to estimate the model quality.
+Its advantage is in unified call ifrastucture to the topic model making the routine and tedious task of extracting the information easy.
 
-Currently module contains following viewers:
+Currently module contains the following viewers:
 
+* `base_viewer` (`BaseViewer`) — module responsible for base infrastructure.
 
-* ```base_viewer``` - module responsible for base infrastructure
+* `document_cluster` (`DocumentClusterViewer`) — module which allows to visualize collection documents. May be slow for large document collections as it uses TSNE algorithm from [sklearn](https://scikit-learn.org/stable/modules/generated/sklearn.manifold.TSNE.html) library.
 
-* ```spectrum``` - module contains heuristics for solving TSP to arrange topics minimizing total distance of the spectrun, 
-```TopicSpectrumViewer```
+<p>
+    <div align="center">
+        <img src="../docs/images/doc_cluster__plot.png" width="80%" alt/>
+    </div>
+    <em>
+        Visualisation of reduced document embeddings colored according to their topic made by DocumentClusterViewer.
+    </em>
+</p>
 
-* ```top_documents_viewer``` - module with functions that work with dataset document collections and class ```TopDocumentsViewer``` wrapping this functionality.
+* `spectrum` (`TopicSpectrumViewer`) — module contains heuristics for solving TSP to arrange topics minimizing total distance of the spectrum.
 
-* ```top_similar_documents_viewer``` - module containing class for finding simmilar document for a givenone. This viewer helps to estimate homogeneity of clusters given by the model
+<p>
+    <div align="center">
+        <img src="../docs/images/topic_spectrum__refined_view.png" width="80%" alt/>
+    </div>
+    <em>
+        Each point on the plot represents some topic.
+        The viewer helped to calculate such a route between topics when one topic is connected with similar one, and so on, forming a circle.
+    </em>
+</p>
 
-* ```top_tokens_viewer``` - module with class for displaying the most relevant tokens in each topic of the model.
+* `top_documents_viewer` (`TopDocumentsViewer`) — module with functions that work with dataset document collections.
 
-* ```topic_mapping``` - module allowing to compare topics between two different models trained on the same collection.
+<p>
+    <div align="center">
+        <img src="../docs/images/top_doc__view.png" width="80%" alt/>
+    </div>
+    <em>
+        The viewer shows fragments of top documents corresponding to some topic.
+    </em>
+</p>
 
-* ```document_cluster``` - module containing  class ```DocumentClusterViewer``` which allows to visualize collection documents. May be slow for large document collections as it uses TSNE algorithm from sklearn library.
+* `top_similar_documents_viewer` (`TopSimilarDocumentsViewer`) — module containing class for finding similar document for a given one. This viewer helps to estimate homogeneity of clusters given by the model.
 
+<p>
+    <div align="center">
+        <img src="../docs/images/top_sim_doc__refined_view.png" width="80%" alt/>
+    </div>
+    <em>
+        Some document from text collection (on top), and documents nearest to it given topic model.
+        The viewer (currently) gives only document names as output, but the picture is not very difficult to be made.
+    </em>
+</p>
 
+* `top_tokens_viewer` (`TopTokensViewer`) — module with class for displaying the most relevant tokens in each topic of the model.
 
-* ```initial_doc_to_topic_viewer``` - first edition of  ```TopDocumentsViewer``` - Deprecated
+<p>
+    <div align="center">
+        <img src="../docs/images/top_tokens__view.png" width="80%" alt/>
+    </div>
+    <em>
+        Output of the TopTokensViewer. Token score in the topic is calculated for every token, score function can be specified at the stage of a viewer initialization.
+    </em>
+</p>
 
-* ```tokens_viewer``` - first edition of  ```TopTokensViewer``` - Deprecated
+* `topic_mapping` (`TopicMapViewer`) — module allowing to compare topics between two different models trained on the same collection.
+
+<p>
+    <div align="center">
+        <img src="../docs/images/topic_map__view.png" width="80%" alt/>
+    </div>
+    <em>
+        The mapping between topics of two models (currently only topic names are displayed).
+    </em>
+</p>
+
+## Deprecated
+
+* `initial_doc_to_topic_viewer` — first edition of `TopDocumentsViewer`
+
+* `tokens_viewer` - first edition of `TopTokensViewer`