💡 All-in-one AI framework for semantic search, LLM orchestration and language model workflows
Python agentsaiai-agentsembeddingsinformation-retrievallanguage-modellarge-language-modelsllmnlppythonragretrieval-augmented-generationsearchsearch-enginesemantic-searchsentence-embeddingstransformerstxtaivector-databasevector-search
Documentation updates
davidmezzettie11db82dd96b
diff --git a/README.md b/README.mdindex 187ee68a..67c3e17b 100644--- a/README.md+++ b/README.md@@ -59,12 +59,12 @@ The easiest way to install is via pip and PyPIpip 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).## Examplesdiff --git a/docs/install.md b/docs/install.mdindex f5fca6dd..8a12458c 100644--- a/docs/install.md+++ b/docs/install.md@@ -4,21 +4,27 @@ The easiest way to install is via pip and PyPIpip 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++Additional environment specific prerequisites are below.-## Linux+### LinuxOptional audio transcription requires a [system library to be installed](https://github.com/bastibe/python-soundfile#installation)-## macOS+### macOSRun `brew install libomp` see [this link](https://github.com/kyamagu/faiss-wheels#prerequisite)-## Windows+### WindowsOptional dependencies require [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)