Skip to content

Add more contextual information to Jupyter notebooks #54

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
446233d
WIP title edits
nrichers Apr 14, 2024
851fb29
WIP title edits
nrichers Apr 14, 2024
084df8d
WIP title edits
nrichers Apr 15, 2024
a130e05
WIP edits
nrichers Apr 15, 2024
4773a3b
Consistency edits
nrichers Apr 15, 2024
304b3e6
WIP intro and next step edits
nrichers Apr 15, 2024
0f7f4a2
WIP test notebook edits
nrichers Apr 16, 2024
5d1c228
WIP edits
nrichers Apr 17, 2024
af36fec
WIP edits
nrichers Apr 17, 2024
57d6d5e
Rename notebook, edits
nrichers Apr 17, 2024
cfe7af6
Rename notebook, add TOCs & standard sections
nrichers Apr 17, 2024
d050555
Fix broken links
nrichers Apr 17, 2024
55d6818
WIP edits
nrichers Apr 18, 2024
17617ad
WIP edits
nrichers Apr 18, 2024
5fa5c60
WIP edits
nrichers Apr 18, 2024
02fb18b
WIP edits
nrichers Apr 18, 2024
fa361be
WIP edits
nrichers Apr 18, 2024
58ec31a
WIP edits
nrichers Apr 18, 2024
cb29fdf
WIP edits
nrichers Apr 18, 2024
2e07bea
WIP edits
nrichers Apr 18, 2024
7cc8786
WIP edits
nrichers Apr 18, 2024
e337093
WIP edits
nrichers Apr 18, 2024
22d2b76
WIP edits
nrichers Apr 18, 2024
ad599a1
Code sample intro edits
nrichers Apr 18, 2024
b0115e7
Fix TOC anchors
nrichers Apr 20, 2024
a4361ae
Edits, anchor fixes
nrichers Apr 20, 2024
3eb479a
Edits
nrichers Apr 24, 2024
9c990c6
Remove blank cell
nrichers Apr 24, 2024
49e380a
Update notebooks/code_samples/custom_tests/integrate-external_test_pr…
nrichers Apr 25, 2024
60af079
Address review comments
nrichers Apr 26, 2024
ecb2e1b
Merge branch 'nrichers/sc-3795/add-explanations-definition-of-concept…
nrichers Apr 26, 2024
829df2d
Merge branch 'main' of github.com:validmind/developer-framework into …
nrichers Apr 26, 2024
813ae99
Fix external test providers notebook
cachafla Apr 27, 2024
294dfaa
Merge branch 'main' into nrichers/sc-3795/add-explanations-definition…
cachafla Apr 30, 2024
da1c0fb
Consistency edits
nrichers Apr 30, 2024
4bfbde6
Add table of contents
nrichers Apr 30, 2024
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
739 changes: 0 additions & 739 deletions notebooks/code_samples/custom_tests/external_test_providers.ipynb

This file was deleted.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Sentiment Analysis of Financial Data Using a Large Language Model (LLM)\n",
"# Sentiment analysis of financial data using a large language model (LLM)\n",
"\n",
"This notebook guides model developers through the process of using a large language model (LLM) specialized in sentiment analysis for financial news. It shows you how to set up the ValidMind Developer Framework, initializes the client library, and uses a specific prompt template for analyzing the sentiment of sentences in a dataset. The notebook also includes example data to test the model's ability to correctly identify sentiment as positive, negative, or neutral.\n"
"Document a large language model (LLM) specialized in sentiment analysis for financial news using the ValidMind Developer Framework. \n",
"\n",
"This interactive notebook shows you how to set up the ValidMind Developer Framework, initializes the client library, and uses a specific prompt template for analyzing the sentiment of sentences in a dataset. The notebook also includes example data to test the model's ability to correctly identify sentiment as positive, negative, or neutral.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## ValidMind at a glance\n",
"## About ValidMind\n",
"\n",
"ValidMind's platform enables organizations to identify, document, and manage model risks for all types of models, including AI/ML models, LLMs, and statistical models. As a model developer, you use the ValidMind Developer Framework to automate documentation and validation tests, and then use the ValidMind AI Risk Platform UI to collaborate on documentation projects. Together, these products simplify model risk management, facilitate compliance with regulations and institutional standards, and enhance collaboration between yourself and model validators.\n",
"\n",
Expand All @@ -35,7 +37,7 @@
"\n",
"For access to all features available in this notebook, create a free ValidMind account.\n",
"\n",
"Signing up is FREE — [**Sign up now**](https://app.prod.validmind.ai)\n",
"Signing up is FREE — [**Sign up now!**](https://app.prod.validmind.ai)\n",
":::\n",
"\n",
"This notebook requires an OpenAI API secret key to run. If you don't have one, visit [API keys](https://platform.openai.com/account/api-keys) on OpenAI's site to create a new key for yourself. Note that API usage charges may apply.\n",
Expand Down Expand Up @@ -302,15 +304,15 @@
"source": [
"## Next steps\n",
"\n",
"You can look at the results of this test suite right in the notebook where you ran the code, as you would expect. But there is a better way: view the prompt validation test results as part of your model documentation right in the ValidMind Platform UI:\n",
"You can look at the results of this test suite right in the notebook where you ran the code, as you would expect. But there is a better way: view the prompt validation test results as part of your model documentation in the ValidMind Platform UI:\n",
"\n",
"1. In the [Platform UI](https://app.prod.validmind.ai), go to the **Documentation** page for the model you registered earlier.\n",
"\n",
"2. Expand **2. Data Preparation** or **3. Model Development** to review all test results.\n",
"\n",
"What you can see now is a more easily consumable version of the prompt validation testing you just performed, along with other parts of your model documentation that still need to be completed.\n",
"\n",
"If you want to learn more about where you are in the model documentation process, take a look at [How do I use the framework?](https://docs.validmind.ai/guide/get-started-developer-framework.html#how-do-i-use-the-framework).\n"
"If you want to learn more about where you are in the model documentation process, take a look at [Get started with the ValidMind Developer Framework](https://docs.validmind.ai/guide/get-started-developer-framework.html).\n"
]
}
],
Expand Down
Loading