Notebook setup documentation & minor notebook fixes #45
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces improvements to notebook setup and logging configuration, simplifies notebook code, and updates dependencies for compatibility and reliability. The main changes include adding a dedicated Jupyter notebook setup guide, refactoring logging initialization to be more consistent and flexible, and updating requirements to ensure proper package versions. Additionally, some minor bug fixes and code cleanups have been made across notebooks and source files.
Notebook setup and documentation:
notebooks/README.md
guide for setting up and running Jupyter notebooks, including troubleshooting steps and kernel setup instructions.docs/evaluation.md
to reference the new notebook setup guide for additional instructions.Logging and initialization improvements:
src/app.py
andsrc/config.py
to ensure logging is initialized with the correct log level and handlers, and moved Application Insights setup into the application context. [1] [2] [3] [4]create_app_context(log_level)
and removed redundantsetup_logging
calls. [1] [2] [3] [4]Dependency and compatibility updates:
jupyter
andipykernel
tosrc/requirements-notebooks.txt
to ensure notebooks run reliably.src/requirements.txt
for compatibility, and fixed a version regression forazure-keyvault-secrets
. [1] [2]Code and path corrections:
src/evaluation/metrics/base.py
to prevent file-not-found errors.notebooks/evaluations/evaluation.ipynb
.Notebook code cleanup:
Does this introduce a breaking change?
Pull Request Type
What kind of change does this Pull Request introduce?
How to Test
Set up infra and run notebooks
What to Check
Verify that the following are valid
Other Information