Skip to content

Commit abc67f0

Browse files
committed
refining image
1 parent 6efa23d commit abc67f0

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
### What is TopicNet?
1212

13-
<div align="center"><img src="./docs/readme_images/training_scheme_example.png" width="60%"/></div>
14-
1513
TopicNet is a high-level interface developed by [Machine Intelligence Laboratory](https://mipt.ai/en) for [BigARTM](https://github.com/bigartm/bigartm) library.
1614

1715
```TopicNet``` library was created to assist in the task of building topic models. It aims at automating model training routine freeing more time for artistic process of constructing a target functional for the task at hand.
@@ -23,11 +21,28 @@ Consider using TopicNet if:
2321
* you want to build a good topic model quickly (out-of-box, with default parameters).
2422
* you have an ARTM model at hand and you want to explore it's topics.
2523

26-
```TopicNet``` provides an infrastructure for your prototyping (```Experiment``` class) and helps to observe results of your actions via ```viewers``` module.
24+
`TopicNet` provides an infrastructure for your prototyping (`Experiment` class) and helps to observe results of your actions via `viewers` module.
25+
26+
<div align="center"><img src="./docs/readme_images/training_scheme_example.png" width="60%"/></div>
27+
28+
Below is an example of the two-stage experiment scheme.
29+
At the first stage, regularizer with parameter <img src="https://render.githubusercontent.com/render/math?math=\tau"> taking values in some range $\{\tau_1, \tau_2, \tau_3\}$ is applied.
30+
Best models after the first stage are \emph{Model 1} and \emph{Model 2}~---~so \emph{Model 3} is not taking part in the training process anymore.
31+
The second stage is connected with another regularizer with parameter $\xi$ taking values in range $\{\xi_1, \xi_2\}$.
32+
As a result of this stage, two descendant models of \emph{Model 1} and two descendant models of \emph{Model 2} are obtained.
33+
34+
<img src="https://render.githubusercontent.com/render/math?math=\tau">
35+
<img src="https://render.githubusercontent.com/render/math?math=e^{i \pi} = -1">
36+
<img src="https://render.githubusercontent.com/render/math?math=e^{i \pi} = -1">
37+
<img src="https://render.githubusercontent.com/render/math?math=e^{i \pi} = -1">
38+
2739

2840
[![GitHub contributors](https://img.shields.io/github/contributors/machine-intelligence-laboratory/TopicNet)](https://github.com/machine-intelligence-laboratory/TopicNet/graphs/contributors)
2941
[![GitHub last commit](https://img.shields.io/github/last-commit/machine-intelligence-laboratory/TopicNet)](https://github.com/machine-intelligence-laboratory/TopicNet/commits/master)
42+
43+
3044
### How to start?
45+
3146
Define `TopicModel` from an ARTM model at hand or with help from `model_constructor` module, where you can set models main parameters. Then create an `Experiment`, assigning a root position to this model and path to store your experiment. Further, you can define a set of training stages by the functionality provided by the `cooking_machine.cubes` module.
3247

3348
Further you can read documentation [here](https://machine-intelligence-laboratory.github.io/TopicNet/). Currently we are in the process of imporving it.

0 commit comments

Comments
 (0)