Skip to content

Commit c3b1627

Browse files
authored
Merge pull request #23 from machine-intelligence-laboratory/bugfix/cosmetic-fix-in-main-ridmi
Small style fix
2 parents af06c09 + 34482d6 commit c3b1627

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
[Русская версия](README-rus.md)
1212

13-
---
1413
### What is TopicNet?
14+
1515
TopicNet is a high-level interface developed by [Machine Intelligence Laboratory](https://mipt.ai/en) for [BigARTM](https://github.com/bigartm/bigartm) library.
1616

1717
```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.
@@ -32,8 +32,8 @@ Define `TopicModel` from an ARTM model at hand or with help from `model_construc
3232

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

35-
---
3635
## How to install TopicNet
36+
3737
**Core library functionality is based on BigARTM library** which required manual installation on all systems.
3838
Currently we have working solution for Linux users:
3939
```
@@ -58,8 +58,8 @@ artm.version()
5858
Alternatively, you can follow [BigARTM installation manual](https://bigartm.readthedocs.io/en/stable/installation/index.html).
5959
After setting up the environment you can fork this repository or use ```pip install topicnet``` to install the library.
6060

61-
---
6261
## How to use TopicNet
62+
6363
Let's say you have a handful of raw text mined from some source and you want to perform some topic modelling on them. Where should you start?
6464
### Data Preparation
6565
Every ML problem starts with data preprocess step. TopicNet does not perform data preprocessing itself. Instead, it demands data being prepared by the user and loaded via [Dataset class.](topicnet/cooking_machine/dataset.py)
@@ -146,7 +146,6 @@ for line in first_model_html:
146146
display_html(line, raw=True)
147147
```
148148

149-
---
150149
## FAQ
151150

152151
#### In the example we used to write vw modality like **@modality**, is it a VowpallWabbit format?
@@ -175,13 +174,19 @@ However for the case of modalities a couple of slightly more convenient methods
175174

176175
```
177176
parameters : [
178-
{'name': 'class_ids@text', 'values': [1, 2, 3]},
179-
{'name': 'class_ids@ngrams', 'values': [4, 5, 6]}
180-
]
177+
{
178+
'name': 'class_ids@text',
179+
'values': [1, 2, 3]
180+
},
181+
{
182+
'name': 'class_ids@ngrams',
183+
'values': [4, 5, 6]
184+
}
185+
]
181186
parameters:[
182187
{
183-
'class_ids@text': [1, 2, 3],
184-
'class_ids@ngrams': [4, 5, 6]
188+
'class_ids@text' : [1, 2, 3],
189+
'class_ids@ngrams': [4, 5, 6]
185190
}
186191
]
187192
```

0 commit comments

Comments
 (0)