Skip to content

Commit

Permalink
General robustness + fix/update guardrail examples and testing (#1275)
Browse files Browse the repository at this point in the history
* add missing content for guardrail

* behind docs update

* update llama-index hybrid retriever example

* md updates

* get quickstart working

* rerun quickstarts

* displays for langchain ensemble retriever

* take selectors from feedback guardrail docs

* add timeout to feedback display util

* fmt

* update llama quickstart

* double quotes

* remove unneeded key calling from test_notebooks

* run combine docs to testing

* clear trulens module between each nb in all_tools

* update all tools

* update all tools/clear trulens module between each nb

* fmt

* run dashboard on unused port

* fmt

* remove unneeded line

* add reasoning md for clear modules

* fix typos

---------

Co-authored-by: Josh Reini <[email protected]>
  • Loading branch information
sfc-gh-jreini and Josh Reini authored Jul 8, 2024
1 parent 03a88cd commit 168515e
Show file tree
Hide file tree
Showing 21 changed files with 3,769 additions and 1,143 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/combine_nb_to_docs_testing.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,21 @@ rm -rf all_tools.ipynb
# IF MOVING ANY IPYNB, MAKE SURE TO RE-SYMLINK. MANY IPYNB REFERENCED HERE LIVE
# IN OTHER PATHS
ALL_NOTEBOOKS=(
./clear_trulens_module.ipynb
./getting_started/quickstarts/langchain_quickstart.ipynb
./clear_trulens_module.ipynb
./getting_started/quickstarts/llama_index_quickstart.ipynb
./clear_trulens_module.ipynb
./getting_started/quickstarts/quickstart.ipynb
./clear_trulens_module.ipynb
./getting_started/quickstarts/prototype_evals.ipynb
./clear_trulens_module.ipynb
./getting_started/quickstarts/human_feedback.ipynb
./clear_trulens_module.ipynb
./getting_started/quickstarts/groundtruth_evals.ipynb
./clear_trulens_module.ipynb
./tracking/logging/logging.ipynb
./clear_trulens_module.ipynb
./evaluation/feedback_implementations/custom_feedback_functions.ipynb
)
echo "Merging notebooks to all_tools.ipynb: ${ALL_NOTEBOOKS[@]}"
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,9 @@ Fine-grained, stack-agnostic instrumentation and comprehensive evaluations help
you to identify failure modes & systematically iterate to improve your
application.

Read more about the core concepts behind TruLens including [Feedback
Functions](https://www.trulens.org/trulens_eval/getting_started/core_concepts/),
Read more about the core concepts behind TruLens including [Feedback Functions](https://www.trulens.org/trulens_eval/getting_started/core_concepts/feedback_functions/),
[The RAG Triad](https://www.trulens.org/trulens_eval/getting_started/core_concepts/rag_triad/),
and [Honest, Harmless and Helpful
Evals](https://www.trulens.org/trulens_eval/getting_started/core_concepts/honest_harmless_helpful_evals/).
and [Honest, Harmless and Helpful Evals](https://www.trulens.org/trulens_eval/getting_started/core_concepts/honest_harmless_helpful_evals/).

## TruLens in the development workflow

Expand Down
22 changes: 0 additions & 22 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +0,0 @@
# How to build and view docs locally

Navigate to the TruLens root directory
```bash
cd trulens
```

Install docs requirements:
```bash
pip install -r docs/docs_requirements.txt
```

Build docs:
```bash
python -m mkdocs build --clean
python -m mkdocs build
```

Serve docs:
```bash
mkdocs serve
```
Loading

0 comments on commit 168515e

Please sign in to comment.