Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cookbook reorganization #1359

Closed
wants to merge 14 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updates
  • Loading branch information
Josh Reini committed Aug 19, 2024
commit 796049dcf33625196352015356b97f571d5ea92b
3 changes: 1 addition & 2 deletions docs/trulens/tracking/instrumentation/langchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ be used to access the retrieved text for evaluation.
)
```


You can find the full quickstart available here: [LangChain Quickstart](trulens.org/trulens/getting_started/quickstarts/langchain_quickstart/)

## Async Support
Expand Down Expand Up @@ -147,7 +146,7 @@ Once you have created the async LLM chain you can instrument it just as before.
)
```

For more usage examples, check out the [LangChain cookbook](https://github.com/truera/trulens/tree/main/examples/expositional/frameworks/langchain).
For examples of using `TruChain`, check out the [_TruLens_ Cookbook](trulens.org/examples/)

## Appendix: Instrumented LangChain Classes and Methods

Expand Down
2 changes: 1 addition & 1 deletion docs/trulens/tracking/instrumentation/llama_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ You can also print the response tokens as they are generated using the `response
print(c)
```

You can find more examples of using TruLens with Llama-Index apps in the [TruLens cookbook]().
For examples of using `TruLlama`, check out the [_TruLens_ Cookbook](trulens.org/examples/)

## Appendix: LlamaIndex Instrumented Classes and Methods

Expand Down
2 changes: 2 additions & 0 deletions docs/trulens/tracking/instrumentation/nemo.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ be used to access the retrieved text for evaluation.
)
```

For examples of using `TruRails`, check out the [_TruLens_ Cookbook](trulens.org/examples/)

## Appendix: Instrumented Nemo Classes and Methods

The modules, classes, and methods that trulens instruments can be retrieved from
Expand Down
7 changes: 4 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ be updated at every *major* release. Experimental examples may break between
release. Dev examples are used to develop or test releases.

Quickstarts contain the simple examples for critical workflows to build,
evaluate and track your LLM app.
evaluate and track your LLM app. These examples are displayed in the
TruLens documentation under the "Getting Started" section.

This expositional library of TruLens examples is organized by the component of
interest. Components include `/models`, `/frameworks` and `/vector-dbs`.

For end to end application examples, checkout `/end2end_apps`.
Use cases are also included under `/use_cases`. These examples can be found
in TruLens documentation as the TruLens cookbook.
5 changes: 5 additions & 0 deletions examples/expositional/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# 🧑‍🍳 TruLens Cookbook

Examples for tracking and evaluating apps with _TruLens_. Examples are organized by different frameworks (such as Langchain or Llama-Index), model (including Azure, OSS models and more), vector store, and use case.

The examples in this cookbook are more focused on applying core concepts to external libraries or end to end applications than the [quickstarts](trulens.org/trulens/getting_started/).
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ nav:
# - LLM Agents: trulens/guides/use_cases_agent.md
# - Dev to Prod: trulens/guides/use_cases_production.md
- API Reference: reference/
- Cookbook: examples/
- 🧑‍🍳 Cookbook: examples/
- 🤝 Contributing:
- trulens/contributing/index.md
- 🧭 Design: trulens/contributing/design.md
Expand Down
Loading