From 7e51a83eacf8516132446d2770fee7a2a63a09bc Mon Sep 17 00:00:00 2001 From: Yuan Tang Date: Mon, 31 Mar 2025 05:37:42 -0400 Subject: [PATCH] docs: Add link to integration tests instructions and minor clarification (#1838) # What does this PR do? * Added `--text-model` in example command. * Added link to integration tests instruction and a note on specifying models. This is to avoid confusion when all tests are skipped because no model is provided. Signed-off-by: Yuan Tang --- CONTRIBUTING.md | 6 +++++- tests/integration/README.md | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21591481e..5828250d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,7 +88,7 @@ BRAVE_SEARCH_API_KEY= And then use this dotenv file when running client SDK tests via the following: ```bash -uv run --env-file .env -- pytest -v tests/integration/inference/test_text_inference.py +uv run --env-file .env -- pytest -v tests/integration/inference/test_text_inference.py --text-model=meta-llama/Llama-3.1-8B-Instruct ``` ## Pre-commit Hooks @@ -126,6 +126,10 @@ source .venv/bin/activate PYTHON_VERSION=3.13 ./scripts/unit-tests.sh ``` +## Running integration tests + +You can run integration tests following the instructions [here](tests/integration/README.md). + ## Adding a new dependency to the project To add a new dependency to the project, you can use the `uv` command. For example, to add `foo` to the project, you can run: diff --git a/tests/integration/README.md b/tests/integration/README.md index beb234740..609831d74 100644 --- a/tests/integration/README.md +++ b/tests/integration/README.md @@ -23,8 +23,8 @@ Model parameters can be influenced by the following options: - `--judge-model`: comma-separated list of judge models. - `--embedding-dimension`: output dimensionality of the embedding model to use for testing. Default: 384 -Each of these are comma-separated lists and can be used to generate multiple parameter combinations. - +Each of these are comma-separated lists and can be used to generate multiple parameter combinations. Note that tests will be skipped +if no model is specified. Experimental, under development, options: - `--record-responses`: record new API responses instead of using cached ones