Doc update 0.0.5 (#81)

Documentation update for 0.0.5

Added
- CLI notebook
- permanent sidebar
- version switching
- installation guidelines
- updated content

---------

Co-authored-by: Tyler Hutcherson <[email protected]>

Author: Sam Partee

.gitignore

@@ -5,4 +5,5 @@ redisvl.egg-info/
 scratch
 .DS_Store
 *.csv
-wiki_schema.yaml
+wiki_schema.yaml
+docs/_build/

CONTRIBUTING.md

@@ -15,21 +15,30 @@ helpful contributions that mean less work for you.
 
 ## Your First Contribution
 
-Unsure where to begin contributing? You can start by looking through some of our issues [listed here](https://github.com/RedisVentures/data-loader/issues).
+Unsure where to begin contributing? You can start by looking through some of our issues [listed here](https://github.com/RedisVentures/redisvl/issues).
 
 ## Getting Started
 
 Here's how to get started with your code contribution:
 
 1.  Create your own fork of this repo
-2.  Apply the changes in your fork
-3.  _We're still working on a development environment setup -- so stay tuned_
-4.  If you like the change and think the project could use it, send a
+2.  Set up your developer environment
+2.  Apply the changes in your forked codebase / environment
+4.  If you like the change and think the project could use it, send us a
     pull request.
 
+### Dev Environment
+There is a provided `requirements.txt` and `requirements-dev.txt` file you can use to install required libraries with `pip` into your virtual environment.
+
 ### Docker Tips
 
->COMING SOON
+Make sure to have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
+
+```bash
+docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
+```
+
+This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
 
 ## How to Report a Bug
 
@@ -55,7 +64,7 @@ issue, so if you're unsure, just email us.
 When filing an issue, make sure to answer these five questions:
 
 1.  What version of python are you using?
-2.  What version of redis are you using?
+2.  What version of `redis` and `redisvl` are you using?
 3.  What did you do?
 4.  What did you expect to see?
 5.  What did you see instead?

Makefile

@@ -65,6 +65,11 @@ mypy:
 docs:
 	@cd docs; make html
 
+# help: servedocs                      - Serve project documentation
+.PHONY: servedocs
+servedocs:
+	@cd docs/_build/html/; python -m http.server
+
 # help:
 # help: Test
 # help: -------
@@ -89,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

README.md

@@ -51,7 +51,7 @@ RedisVL has a host of powerful features designed to streamline your vector datab
     - **Semantic Caching**: `LLMCache` is a semantic caching interface built directly into RedisVL. It allows for the caching of generated output from LLMs like GPT-3 and others. As semantic search is used to check the cache, a threshold can be set to determine if the cached result is relevant enough to be returned. If not, the model is called and the result is cached for future use. This can increase the QPS and reduce the cost of using LLM models in production.
 
 
-## 😊 Quick Start
+## Installation
 
 Please note that this library is still under heavy development, and while you can quickly try RedisVL and deploy it in a production environment, the API may be subject to change at any time.
 
@@ -81,7 +81,7 @@ This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterpris
 
 ### Index Management
 
-Indices can be defined through yaml specification that corresponds directly to the RediSearch field names and arguments in redis-py
+Indices can be defined through yaml specification, or json, that correspond directly to the Redis index, field names and arguments in `redis-py`. Take this example `idx.yaml` file:
 
 ```yaml
 index:
@@ -105,7 +105,7 @@ fields:
     distance_metric: cosine
 ```
 
-This would correspond to a dataset that looked something like
+This would correspond to a dataset that looked something like:
 
 | user  | age |     job    | credit_score |           user_embedding          |
 |-------|-----|------------|--------------|-----------------------------------|
@@ -114,14 +114,14 @@ This would correspond to a dataset that looked something like
 |  joe  |  3  |  dentist   |    medium    | \x3f\xab\xcc?\xab\xcc?@         |
 
 
-With the schema, the RedisVL library can be used to create, load vectors and perform vector searches
+With the YAML schema, the RedisVL library can be used to create the index, load vectors and perform vector searches:
 ```python
 
 from redisvl.index import SearchIndex
 from redisvl.query import VectorQuery
 
-# initialize the index and connect to Redis
-index = SearchIndex.from_dict(schema)
+# initialize the index and connect to local Redis
+index = SearchIndex.from_schema("idx.yaml")
 index.connect("redis://localhost:6379")
 
 # create the index in Redis
@@ -140,9 +140,9 @@ results = index.query(query)
 
 ```
 
-### Flexible Querying
+### Redis Filter Expressions
 
-RedisVL supports a variety of filter types, including tag, numeric, geographic, and full text search to create filter expressions. Filter expressions can be used to create hybrid queries which allow you to combine multiple query types (i.e. text and vector search) into a single query.
+RedisVL supports a variety of filter types, including tag, numeric, geographic, and full text search to create *Filter Expressions*. Filter expressions can be used to create hybrid queries which allow you to combine multiple complex data types (i.e. text and vector search) into a single query.
 
 ```python
 from redisvl.index import SearchIndex
@@ -174,6 +174,40 @@ results = index.query(query)
 
 ```
 
+### Interoperability with core Redis Clients
+The purpose of RedisVL is **NOT** to fully replace your usage of the trusted Redis client libraries. It's simply here to make your life easier getting started and building generative AI applications on top of Redis. With that in mind, the RedisVL query interface and filter expressions can be ported and used with clients like `redis-py`.
+
+Take the example filter expression from above:
+```python
+print(str(filter_expression))
+```
+
+This prints the RediSearch hybrid filter expression:
+```
+'(((@user:{Sam} @age:[(10 +inf]) @location:[37.774900 -122.419400 10 km]) @job:enginee*)'
+```
+
+Take the fully formed vector query from above:
+```python
+print(str(query))
+```
+
+This prints the full RediSearch query, including hybrid filters and VSS:
+```
+'(((@user:{Sam} @age:[(10 +inf]) @location:[37.774900 -122.419400 10 km]) @job:enginee*)=>[KNN 3 @user_embedding $vector AS vector_distance] RETURN 5 user age job credit_score vector_distance SORTBY vector_distance ASC DIALECT 2 LIMIT 0 3'
+```
+
+> Both of these query strings and expressions can be used with the core RediSearch API.
+
+For example, use the RedisVL `query` object with the standard `redis-py` client:
+```python
+import redis
+
+r = redis.Redis.from_url("redis://localhost:6379")
+
+results = r.ft("user_index").search(query.query, query.params)
+```
+
 ### Semantic cache
 
 The ``LLMCache`` Interface in RedisVL can be used as follows.
@@ -193,11 +227,17 @@ cache.check("What is the capital of France?")
 # store a result for a given query
 cache.store("What is the capital of France?", "Paris")
 
-# Cache will now have the query
+# cache will now have the query
 cache.check("What is the capital of France?")
 ["Paris"]
 
-# Cache will still return the result if the query is similar enough
-cache.check("What really is the capital of France?")
+# cache will still return the result if the query is similar enough
+cache.check("Question -- What really is the capital of France?")
 ["Paris"]
 ```
+<<<<<<< HEAD
+=======
+
+## Contributing
+Please help us by contributing PRs or opening GitHub issues for desired behaviors or discovered bugs. [Read more about how to contribute to RedisVL!](CONTRIBUTING.md)
+>>>>>>> 2ef8e43 (update contributing and reade)