Update docs landing page and docstrings (#47)

- Add missing punctuation and fix spelling and phrasing.
- Add back section for vectorizers.

Author: tylerhutcherson

.github/workflows/run_tests.yml

@@ -33,8 +33,8 @@ jobs:
         pip install .[dev,all]
     - name: Start Redis
       run: |
-        REDIS_ADDRESS=redis://localhost:6379
-        echo REDIS_ADDRESS=$REDIS_ADDRESS >> $GITHUB_ENV
+        REDIS_URL=redis://localhost:6379
+        echo REDIS_URL=$REDIS_URL >> $GITHUB_ENV
     - name: Run tests
       env:
         OPENAI_API_KEY: ${{ secrets.OPENAI_KEY }}

conftest.py

@@ -6,14 +6,14 @@
     get_async_redis_connection,
     get_redis_connection
 )
-REDIS_ADDRESS = os.getenv("REDIS_ADDRESS", "redis://localhost:6379")
+REDIS_URL = os.getenv("REDIS_URL", "redis://localhost:6379")
 
-aredis = get_async_redis_connection(REDIS_ADDRESS)
-redis = get_redis_connection(REDIS_ADDRESS)
+aredis = get_async_redis_connection(REDIS_URL)
+redis = get_redis_connection(REDIS_URL)
 
 @pytest.fixture()
 def redis_url():
-    return REDIS_ADDRESS
+    return REDIS_URL
 
 @pytest.fixture
 def async_client():

docs/api/index.md

@@ -14,6 +14,7 @@ myst:
 searchindex
 query
 filter
+vectorizer
 cache
 ```
 

docs/api/vectorizer.rst

@@ -0,0 +1,46 @@
+
+*****
+Vectorizer
+*****
+
+HFTextVectorizer
+===========
+
+.. _hftextvectorizer_api:
+
+.. currentmodule:: redisvl.vectorize.text.huggingface
+
+.. autosummary::
+
+    HFTextVectorizer.__init__
+    HFTextVectorizer.embed
+    HFTextVectorizer.embed_many
+
+.. autoclass:: HFTextVectorizer
+   :show-inheritance:
+   :inherited-members:
+   :members:
+
+
+OpenAITextVectorizer
+================
+
+.. _openaitextvectorizer_api:
+
+.. currentmodule:: redisvl.vectorize.text.openai
+
+.. autosummary::
+
+    OpenAITextVectorizer.__init__
+    OpenAITextVectorizer.embed
+    OpenAITextVectorizer.embed_many
+    OpenAITextVectorizer.aembed
+    OpenAITextVectorizer.aembed_many
+
+.. autoclass:: OpenAITextVectorizer
+   :show-inheritance:
+   :inherited-members:
+   :members:
+
+
+

docs/index.md

@@ -17,20 +17,23 @@ to supercharge your application!
 :grid-columns: 1 2 2 3
 
 - header: "{fab}`bootstrap;pst-color-primary` Index Management"
-  content: "Manipulate Redis index in Python for from a CLI."
-- header: "{fas}`bolt;pst-color-primary` Vector Search"
-  content: "Simple vector search capabilities supporting synchronous and asyncronous search."
+  content: "Manipulate Redis search indices in Python or from CLI."
+- header: "{fas}`bolt;pst-color-primary` Vector Similarity Search"
+  content: "Perform powerful vector similarity search with filtering support."
 - header: "{fas}`circle-half-stroke;pst-color-primary` Embedding Creation"
-  content: "User OpenAI or any of the other supported vectorizers to create embeddings"
+  content: "Use OpenAI or any of the other supported vectorizers to create embeddings."
 - header: "{fas}`palette;pst-color-primary` CLI"
-  content: "Command line interface for RedisVL makes interacting with Redis as a vector database easy."
+  content: "Interact with RedisVL using a Command line interface (CLI) for ease of use."
 - header: "{fab}`python;pst-color-primary` Semantic Caching"
-  content: "Use RedisVL to cache the results of your LLM models increasing QPS and decreasing cost."
+  content: "Use RedisVL to cache LLM results, increasing QPS and decreasing cost."
 - header: "{fas}`lightbulb;pst-color-primary` Example Gallery"
-  content: "See our gallery of projects that use RedisVL"
+  content: "Explore our gallery of examples to get started."
   link: "examples/index"
 ```
 
+## Concepts (Coming Soon)
+
+Glossary of AI terminology and concepts related to vector databases.
 
 
 ## User Guide
@@ -65,19 +68,9 @@ The redisVL API
 API <api/index>
 ```
 
-## Developer
-
-How to contribute
-
-```{toctree}
-:maxdepth: 2
-
-developer/index
-```
-
 
 ```{toctree}
 :hidden:
 
-Changelog <https://github.com/pydata/pydata-sphinx-theme/releases>
+Changelog <https://github.com/RedisVentures/redisvl/releases>
 ```

redisvl/cli/index.py

@@ -111,7 +111,7 @@ def _connect_to_index(self, args: Namespace) -> SearchIndex:
             conn = get_redis_connection(url=url)
         except ValueError:
             logger.error(
-                "Must set REDIS_ADDRESS environment variable or provide host and port"
+                "Must set REDIS_URL environment variable or provide host and port"
             )
             exit(0)
 

redisvl/cli/utils.py

@@ -3,7 +3,7 @@
 
 
 def create_redis_url(args: Namespace) -> str:
-    env_address = os.getenv("REDIS_ADDRESS")
+    env_address = os.getenv("REDIS_URL")
     if env_address:
         return env_address
     else: