Skip to content

Commit

Permalink
add example notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
TimSchopf committed Jul 20, 2021
1 parent 1421c4c commit 2d69eaf
Show file tree
Hide file tree
Showing 7 changed files with 3,163 additions and 41 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,17 @@ Installation
------------

```
$ pip install lbl2vec
pip install lbl2vec
```

Usage
-----
For detailed information view the [Lbl2Vec API Guide](https://lbl2vec.readthedocs.io/en/latest/api.html#).
For detailed information visit the [Lbl2Vec API Guide](https://lbl2vec.readthedocs.io/en/latest/api.html#) and the [examples](https://github.com/sebischair/Lbl2Vec/tree/main/examples).

```
from lbl2vec import Lbl2Vec
```

### Learn new model from scratch
>Learns word vectors, document vectors and label vectors from scratch during Lbl2Vec model training.
Expand Down Expand Up @@ -124,4 +125,14 @@ model.predict_new_docs(tagged_docs=tagged_docs)

**Important parameters:**

* `tagged_docs`: iterable list of [gensim.models.doc2vec.TaggedDocument](https://radimrehurek.com/gensim/models/doc2vec.html#gensim.models.doc2vec.TaggedDocument) elements
* `tagged_docs`: iterable list of [gensim.models.doc2vec.TaggedDocument](https://radimrehurek.com/gensim/models/doc2vec.html#gensim.models.doc2vec.TaggedDocument) elements

### Save model to disk
```
model.save('model_name')
```

### Load model from disk
```
model = Lbl2Vec.load('model_name')
```
Loading

0 comments on commit 2d69eaf

Please sign in to comment.