Skip to content

Commit

Permalink
Updated README and changed setup to use pymagnitude-lite
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmezzetti committed Aug 11, 2020
1 parent 58d193f commit 569d356
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ txtai is built on the following stack:
- Python 3.6+

## Installation
You can install txtai directly from GitHub using pip. Using a Python Virtual Environment is recommended.
The easiest way to install is via pip and PyPI

pip install txtai

You can also install txtai directly from GitHub using pip. Using a Python Virtual Environment is recommended.

pip install git+https://github.com/neuml/txtai

Expand All @@ -45,5 +49,5 @@ The examples directory has a series of examples and notebooks giving an overview
|:----------|:-------------|------:|
| [Introducing txtai](https://github.com/neuml/txtai/blob/master/examples/01_Introducing_txtai.ipynb) | Overview of the functionality provided by txtai |[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/01_Introducing_txtai.ipynb) |
| [Extractive QA with txtai](https://github.com/neuml/txtai/blob/master/examples/02_Extractive_QA_with_txtai) | Extractive question-answering with txtai |[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/02_Extractive_QA_with_txtai.ipynb) |
| [Build an Embeddings index from a data source](https://github.com/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb) | Embeddings index from a data source backed by word embeddings |[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source) |
| [Build an Embeddings index from a data source](https://github.com/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb) | Embeddings index from a data source backed by word embeddings |[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb) |
| [Extractive QA with Elasticsearch](https://github.com/neuml/txtai/blob/master/examples/04_Extractive_QA_with_Elasticsearch.ipynb) | Extractive question-answering with Elasticsearch |[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/04_Extractive_QA_with_Elasticsearch.ipynb) |
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"fasttext>=0.9.2",
"nltk>=3.5",
"numpy>=1.18.4",
"pymagnitude @ git+https://github.com/neuml/magnitude",
"pymagnitude-lite>=0.1.43",
"regex>=2020.5.14",
"scikit-learn>=0.23.1",
"torch>=1.4.0",
Expand Down

0 comments on commit 569d356

Please sign in to comment.