Skip to content

Commit

Permalink
Update Version, add cli notebook, add versions
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Partee committed Nov 22, 2023
1 parent aac6b58 commit f0bab76
Show file tree
Hide file tree
Showing 21 changed files with 384 additions and 314 deletions.
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,9 @@ test-cov:
cov:
@coverage html
@echo if data was present, coverage report is in ./htmlcov/index.html


# help: test-notebooks - Run all notebooks
.PHONY: test-notebooks
test-notebooks:
@cd docs/ && treon -v
Binary file added docs/_static/gallery-images/arxiv-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/gallery-images/bytewax-redis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 6 additions & 7 deletions docs/_static/gallery.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Metadata to create our example gallery. This YAML file does two things:
#
# 1. Used by `generate_gallery_images.py` to take snapshots of each item and place an image in `gallery`.
# 2. Used by our Gallery Grid directive to create the grid on our `examples/gallery.md` page.
#
# This file should only be modified by maintainer, contributors should add their project
# to the list of `gallery.md`.

- title: Arxiv Paper Search
website: https://docsearch.redisventures.com
img-bottom: ../_static/gallery-images/arxiv-search.png
- title: Real-Time Embeddings with Redis and Bytewax
website: https://github.com/awmatheson/real-time-embeddings
img-bottom: ../_static/gallery-images/bytewax-redis.png
- title: Question and Answer with OpenAI
website: https://www.redisvl.com/docs/html/examples/openai_qna.html
img-bottom: ../_static/gallery-images/RedisOpenAI-QnA.png
Expand Down
13 changes: 6 additions & 7 deletions docs/_static/js/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ const toc = [
{ header: "Overview", toc: [
{ title: "RedisVL", path: "/index.html" },
{ title: "Install", path: "/overview/installation.html" },
{ title: "Quickstart", path: "/overview/quickstart.html" },
{ title: "CLI", path: "/overview/cli.html" },
{ title: "CLI", path: "/user_guide/cli.html" },
]},
{ header: "User Guide", toc: [
{ title: "Getting Started", path: "/user_guide/getting_started_01.html" },
Expand All @@ -20,11 +19,11 @@ const toc = [
{ title: "Vectorizers", path: "/api/vectorizer.html" },
{ title: "LLMCache", path: "/api/cache.html" }
]},
{ header: "Concepts", toc: [
{ title: "Vector Embeddings", path: "/concepts/vectors.html" },
{ title: "HNSW vs Flat", path: "/concepts/vector_index.html" },
{ title: "Distance Metrics", path: "/concepts/distance.html" }
]}
// { header: "Concepts", toc: [
// { title: "Vector Embeddings", path: "/concepts/vectors.html" },
// { title: "HNSW vs Flat", path: "/concepts/vector_index.html" },
// { title: "Distance Metrics", path: "/concepts/distance.html" }
//]}
];

document.addEventListener('DOMContentLoaded', function() {
Expand Down
21 changes: 13 additions & 8 deletions docs/_static/version_names.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"version_names":[
"0.1.0"
],
"version_urls": [
"https://www.craylabs.org/develop/overview.html",
]
}
[
{
"name": "0.0.5 (stable)",
"version": "0.0.5",
"url": "/",
"preferred": true
},
{
"name": "0.0.4",
"version": "0.0.4",
"url": "/0.0.4/"
}
]
2 changes: 1 addition & 1 deletion docs/api/vectorizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ OpenAITextVectorizer


VertexAITextVectorizer
================
======================

.. _vertexaitextvectorizer_api:

Expand Down
49 changes: 0 additions & 49 deletions docs/concepts/distance.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/concepts/hybrid.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/concepts/llm.md

This file was deleted.

Loading

0 comments on commit f0bab76

Please sign in to comment.