Skip to content

Commit 1d00530

Browse files
committed
[ci skip] fix link in demos readme
1 parent 147c3ab commit 1d00530

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

topicnet/demos/README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,37 @@
1-
# Demo
1+
# Demos
2+
23
This section provides demonstrations of how to use this library in NLP tasks.
34

4-
1. [RTL-Wiki-Preprocessing](RTL-Wiki-Preprocessing.ipynb) -- notebook working with a dataset introduced in [1]. It serves as an example of a typical preprocessing pipeline: getting a dataset, lemmatizing it, extracting n-grams/collocations, writing data in VW format
5+
1. [RTL-Wiki-Preprocessing](RTL-Wiki-Preprocessing.ipynb) — notebook working with a dataset introduced in [1]. It serves as an example of a typical preprocessing pipeline: getting a dataset, lemmatizing it, extracting n-grams/collocations, writing data in VW format
6+
7+
2. [RTL-Wiki-Building-Topic-Mode](RTL-Wiki-Building-Topic-Model.ipynb) — notebook with first steps to build topic model by consequently tuning its hyperparameters
58

6-
2. [RTL-Wiki-Building-Topic-Mode](RTL-Wiki-Building-Topic-Model.ipynb) -- notebook with first steps to build topic model by consequently tuning its hyperparameters
9+
3. [Visualizing-Your-Model-Documents](Visualizing-Your-Model-Documents.ipynb) notebook providing a fresh outlook on unstructured document collection with the help of a topic model
710

8-
3. [Visualizing-Your-Model-Documents](Visualizing-Your-Model-Documents.ipynb) -- notebook providing a fresh outlook on unstructured document collection with the help of a topic model
11+
4. [20NG-Preprocessing](20NG-Preprocessing.ipynb) — preparing data from a well-know 20 Newsgroups dataset
912

10-
4. [20NG-Preprocessing](20NG-Preprocessing.ipynb) -- preparing data from a well-know 20 Newsgroups dataset
13+
5. [20NG-GenSim-vs-TopicNet](20NG-GenSim-vs-TopicNet.ipynb) — a comparison between two topic models build by Gensim and TopicNet library. In the notebook we compare model topics by calculating their UMass coherence measure with the help of [Palmetto](https://palmetto.demos.dice-research.org/) and using Jaccard measure to compare topic top-tokens diversity
1114

12-
5. [20NG-GenSim-vs-TopicNet](20NG-GenSim-vs-TopicNet.ipynb) -- a comparison between two topic models build by Gensim and TopicNet library. In the notebook we compare model topics by calculating their UMass coherence measure with the help of [Palmetto](https://palmetto.demos.dice-research.org/) and using Jaccard measure to compare topic top-tokens diversity
15+
6. [PostNauka-Building-Topic-Model](PostNauka-Building-Topic-Model.ipynb) — an analog of the RTL-Wiki notebook performed on the corpus of Russian pop-science articles given by postnauka.ru
1316

14-
6. [PostNauka-Building-Topic-Model](PostNauka-Building-Topic-Model.ipynb)-- an analog of the RTL-Wiki notebook performed on the corpus of Russian pop-science articles given by postnauka.ru
17+
7. [PostNauka-Recipe](PostNauka-Recipe.ipynb) — a demonstration of rapid-prototyping methods provided by the library
1518

16-
7. [PostNauka-Recipe](PostNauka-Recipe.ipynb) -- a demonstration of rapid-prototyping methods provided by the library
19+
8. [Coherence-Maximization-Recipe](Coherence-Maximization-Recipe.ipynb) a recipe for hyperparameter search in regard to custom Coherence metric
1720

18-
8. [Coherence-Maximization-Recipe](Coherence-Maximization-Recipe.ipynb) -- a recipe for hyperparameter search in regard to custom Coherence metric
21+
9. [Topic-Prior-Regularizer-Tutorial](Topic-Prior-Regularizer-Tutorial.ipynb) a demonstration of the approach to learning topics from the unbalanced corpus
1922

20-
9. [Topic-Prior-Regularizer-Tutorial](Topic-Prior-Regularizer-Tutorial.ipynb) -- a demonstration of the approach to learning topics from the unbalanced corpus
23+
10. [Making-Decorrelation-and-Topic-Selection-Friends](Making-Decorrelation-and-Topic-Selection-Friends.ipynb) — reproduction of a very complicated experiment on automatically learning optimal number of topics from the collection. Hurdle is -- both needed regularizers when working together nullify token-topic matrix.
2124

22-
10. [Making-Decorrelation-and-Topic-Selection-Friends](Making-Decorrelation-and-Topic-Selection-Friends.ipynb) -- reproduction of a very complicated experiment on automatically learning optimal number of topics from the collection. Hurdle is -- both needed regularizers when working together nullify token-topic matrix.
25+
11. [Topic-Thetaless-Regularizer](Topic-Thetaless-Regularizer.ipynb) — the Additive Regularization of Topic Models (ARTM) formalism views the topic modeling task as an optimization problem and leverages various computational and optimization tricks to make it converge faster and more predictably. This is an example of such optimization (let's reduce the number of inferred parameters), interpreted as a powerful custom regularizer.
2326

24-
11. [Topic-Thetaless-Regularizer](topic_thetaless_regularizer.ipynb) -- The Additive Regularization of Topic Models (ARTM) formalism views the topic modeling task as an optimization problem and leverages various computational and optimization tricks to make it converge faster and more predictably. This is an example of such optimization (let's reduce the number of inferred parameters), interpreted as a powerful custom regularizer.
2527

28+
## References
2629

27-
----
2830
[1](https://dl.acm.org/doi/10.5555/2984093.2984126) Jonathan Chang, Jordan Boyd-Graber, Sean Gerrish, Chong Wang, and David M. Blei. 2009. Reading tea leaves: how humans interpret topic models. In Proceedings of the 22nd International Conference on Neural Information Processing Systems (NIPS’09). Curran Associates Inc., Red Hook, NY, USA, 288–296.
2931

30-
----
31-
P.S. All the guides are supposed to contain **working** examples of the library code.
32+
33+
## P.S.
34+
35+
All the guides are supposed to contain **working** examples of the library code.
3236
If you happen to find code that is no longer works, please write about it in the library issues.
3337
We will try to resolve it as soon as possible and plan to include fixes in the nearest releases.

0 commit comments

Comments
 (0)