@@ -50,8 +50,9 @@ If you use `make`, we've created shortcuts for running the commands in this docu
5050| make format | Runs code formatting and import sorting |
5151| make check-types | Runs mypy type checking |
5252| make lint | Runs formatting, import sorting, and type checking |
53- | make test | Runs tests, excluding those that require API keys and/or remote network calls)|
54- | make test-all | Runs all tests, including those that require API keys and/or remote network calls)|
53+ | make test | Runs tests, excluding those that require API keys and/or remote network calls|
54+ | make test-all | Runs all tests, including those that require API keys and/or remote network calls|
55+ | make test-notebooks | Runs all notebook tests|
5556| make check | Runs all linting targets and a subset of tests |
5657| make docs-build | Builds the documentation |
5758| make docs-serve | Serves the documentation locally |
@@ -76,19 +77,14 @@ To run Testcontainers-based tests you need a local Docker installation such as:
7677
7778#### Running the Tests
7879
79- Tests w/ vectorizers :
80+ Tests w/ external APIs :
8081``` bash
81- poetry run test-verbose
82- ```
83-
84- Tests w/out vectorizers:
85- ``` bash
86- SKIP_VECTORIZERS=true poetry run test-verbose
82+ poetry run test-verbose --run-api-tests
8783```
8884
89- Tests w/out rerankers :
85+ Tests w/out external APIs :
9086``` bash
91- SKIP_RERANKERS=true poetry run test-verbose
87+ poetry run test-verbose
9288```
9389
9490### Documentation
@@ -112,6 +108,17 @@ In order for your applications to use RedisVL, you must have [Redis](https://red
112108docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
113109```
114110
111+ Or from your makefile simply run:
112+
113+ ``` bash
114+ make redis-start
115+ ```
116+
117+ And then:
118+ ``` bash
119+ make redis-stop
120+ ```
121+
115122This will also spin up the [ FREE RedisInsight GUI] ( https://redis.io/insight/ ) at ` http://localhost:8001 ` .
116123
117124## How to Report a Bug
0 commit comments