neuml/txtai
1
0
Fork 0
mirror of https://github.com/neuml/txtai.git synced 2026-10-12 02:19:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
davidmezzetti
2021-08-16 12:53:24 -04:00
parent 57b2018f66
commit e11db82dd9
2 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -59,12 +59,12 @@ The easiest way to install is via pip and PyPI
pip install txtai
You can also install txtai directly from GitHub. Using a Python Virtual Environment is recommended.
Python 3.6+ is supported. Using a Python [virtual environment](https://docs.python.org/3/library/venv.html) is recommended.
pip install git+https://github.com/neuml/txtai
Python 3.6+ is supported. See the detailed [install instructions](https://neuml.github.io/txtai/install) for more information covering optional
dependencies and environment specific prerequisites.
See the detailed [install instructions](https://neuml.github.io/txtai/install) for more information covering
[installing from source](https://neuml.github.io/txtai/install/#install-from-source),
[environment specific prerequisites](https://neuml.github.io/txtai/install/#environment-specific-prerequisites) and
[optional dependencies](https://neuml.github.io/txtai/install/#optional-dependencies).
## Examples
docs/install.md
+11 -5
View File
@@ -4,21 +4,27 @@ The easiest way to install is via pip and PyPI
pip install txtai
You can also install txtai directly from GitHub. Using a Python Virtual Environment is recommended.
Python 3.6+ is supported. Using a Python [virtual environment](https://docs.python.org/3/library/venv.html) is recommended.
## Install from source
txtai can also be installed directly from GitHub to access the latest, unreleased features.
pip install git+https://github.com/neuml/txtai
Python 3.6+ is supported. Additional environment specific prerequisites are below.
## Environment specific prerequisites
## Linux
Additional environment specific prerequisites are below.
### Linux
Optional audio transcription requires a [system library to be installed](https://github.com/bastibe/python-soundfile#installation)
## macOS
### macOS
Run `brew install libomp` see [this link](https://github.com/kyamagu/faiss-wheels#prerequisite)
## Windows
### Windows
Optional dependencies require [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)