Skip to content

Commit e0b4e52

Browse files
committed
2 parents 53c1d7c + 7af52f3 commit e0b4e52

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Consider using TopicNet if:
1717
```TopicNet``` provides an infrastructure for your prototyping (```Experiment``` class) and helps to observe results of your actions via ```viewers``` module.
1818

1919
### How to start?
20-
Define `TopicModel` from an ARTM model at hand or with help from `model_constructor` module. Then create an `Experiment`, assigning a root position to this model. Further, you can define a set of training stages by the functionality provided by the `cooking_machine.cubes` module.
20+
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.
2121

2222
---
2323
## How to install TopicNet
2424
**Core library functionality is based on BigARTM library** which requires manual installation.
25-
To avoid that you can use [docker images](https://hub.docker.com/r/xtonev/bigartm/tags) with preinstalled BigARTM library in them.
25+
To avoid that you can use [docker images](https://hub.docker.com/r/xtonev/bigartm/tags) with preinstalled different versions of BigARTM library in them.
2626

2727
#### Using docker image
2828
```
@@ -90,12 +90,13 @@ custom_score_dict = {'SpecificSparsity': CustomScore()}
9090
tm = TopicModel(model_artm, model_id='Groot', custom_scores=custom_score_dict)
9191
```
9292
#### Define experiment
93+
For further model training and tuning `Experiment` is necessary:
9394
```
9495
from topicnet.cooking_machine.experiment import Experiment
9596
experiment = Experiment(experiment_id="simple_experiment", save_path="experiments", topic_model=tm)
9697
```
9798
#### Toy with the cubes
98-
Defining a next stage of the model training:
99+
Defining a next stage of the model training to select a decorrelator parameter:
99100
```
100101
from topicnet.cooking_machine.cubes import RegularizersModifierCube
101102

0 commit comments

Comments
 (0)