Skip to content

armgit / txtai

Public Imported from GitHub
0

💡 All-in-one AI framework for semantic search, LLM orchestration and language model workflows

Update documentation images

davidmezzettia34e27e776e4
diff --git a/docs/api.md b/docs/api.md
index 375357cb..a5739dfd 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -1,7 +1,7 @@
# API
-![api](../images/api.png#only-light)
-![api](../images/api-dark.png#only-dark)
+![api](images/api.png#only-light)
+![api](images/api-dark.png#only-dark)
txtai has a full-featured API that can optionally be enabled for any txtai process. All functionality found in txtai can be accessed via the API. The following is an example configuration and startup script for the API.
diff --git a/docs/embeddings/index.md b/docs/embeddings/index.md
index 47c2de34..ed920a53 100644
--- a/docs/embeddings/index.md
+++ b/docs/embeddings/index.md
@@ -1,7 +1,7 @@
# Embeddings
-![embeddings](/images/embeddings.png#only-light)
-![embeddings](/images/embeddings-dark.png#only-dark)
+![embeddings](../images/embeddings.png#only-light)
+![embeddings](../images/embeddings-dark.png#only-dark)
Embeddings is the engine that delivers semantic search. Data is transformed into embeddings vectors where similar concepts will produce similar vectors. Indexes both large and small are built with these vectors. The indexes are used find results that have the same meaning, not necessarily the same keywords.
diff --git a/docs/examples.md b/docs/examples.md
index 1e1c1307..74bd7cb3 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -1,7 +1,7 @@
# Examples
-![examples](/images/examples.png#only-light)
-![examples](/images/examples-dark.png#only-dark)
+![examples](images/examples.png#only-light)
+![examples](images/examples-dark.png#only-dark)
The examples directory has a series of notebooks and applications giving an overview of txtai. See the sections below.
diff --git a/docs/install.md b/docs/install.md
index 41632a6e..10a930a0 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,7 +1,7 @@
# Installation
-![install](/images/install.png#only-light)
-![install](/images/install-dark.png#only-dark)
+![install](images/install.png#only-light)
+![install](images/install-dark.png#only-dark)
The easiest way to install is via pip and PyPI
diff --git a/docs/pipeline/index.md b/docs/pipeline/index.md
index 1981ef1c..e67073c6 100644
--- a/docs/pipeline/index.md
+++ b/docs/pipeline/index.md
@@ -1,7 +1,7 @@
# Pipeline
-![pipeline](/images/pipeline.png#only-light)
-![pipeline](/images/pipeline-dark.png#only-dark)
+![pipeline](../images/pipeline.png#only-light)
+![pipeline](../images/pipeline-dark.png#only-dark)
txtai provides a generic pipeline processing framework with the only interface requirement being a `__call__` method. Pipelines are flexible and can
process various types of data. Pipelines can wrap machine learning models as well as other processes.
diff --git a/docs/why.md b/docs/why.md
index 2dc7b086..600213a0 100644
--- a/docs/why.md
+++ b/docs/why.md
@@ -1,7 +1,7 @@
# Why txtai?
-![why](/images/why.png#only-light)
-![why](/images/why-dark.png#only-dark)
+![why](images/why.png#only-light)
+![why](images/why-dark.png#only-dark)
In addition to traditional search systems, a growing number of semantic search solutions are available, so why txtai?
diff --git a/docs/workflow/index.md b/docs/workflow/index.md
index 04188cee..1f7063b7 100644
--- a/docs/workflow/index.md
+++ b/docs/workflow/index.md
@@ -1,7 +1,7 @@
# Workflow
-![workflow](/images/workflow.png#only-light)
-![workflow](/images/workflow-dark.png#only-dark)
+![workflow](../images/workflow.png#only-light)
+![workflow](../images/workflow-dark.png#only-dark)
Workflows are a simple yet powerful construct that takes a callable and returns elements. Workflows operate well with pipelines but can work with any callable object. Workflows are streaming by nature and work on data in batches, allowing large volumes of data to be processed efficiently.