[GSK-3963] refactor: standardise string formatting and improve code readability #2133
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…in various notebooks - Updated string quotes from single to double for consistency across notebooks. - Reformatted multi-line statements for better readability in several code cells. - Ensured proper indentation and spacing in function definitions and data processing steps. - Enhanced clarity in comments and variable names where applicable.
- Added section for installing dependencies using PDM as the package manager. - Clarified that pre-commit hooks are installed as a dev dependency with PDM. - Improved formatting for shell command blocks for consistency. - Enhanced troubleshooting instructions for compatibility issues with libomp on MacOS.
- Corrected a typo in the pre-commit configuration description. - Added instructions to enable the `ggshield` pre-commit hook by commenting out `skip: true`. - Clarified that pre-commit hooks run automatically during commits.
davidberenstein1957
changed the title
davidberenstein1957
changed the title
- Updated introductory sections to provide context about Giskard and its capabilities. - Improved markdown formatting for clarity and added additional explanations for each step in the RAG pipeline. - Included instructions for installing dependencies and downloading reports. - Enhanced the evaluation section with clearer descriptions of the evaluation process and metrics used. - Added markdown cells to guide users through the process of generating test sets and evaluating agent performance.
- Revised introductory sections to enhance context and setup instructions for the Banking Supervision and IPCC reports. - Updated markdown cells to provide clearer guidance on importing libraries and configuring the environment. - Enhanced code organization by removing redundant imports and improving execution count handling. - Added detailed explanations for building RAG agents and processing documents, ensuring a smoother user experience.
…istency - Removed outdated references to the push index in various documentation files. - Enhanced the text generation tests documentation with improved formatting and additional context. - Updated the LLM vulnerabilities section to include a comprehensive table of contents for better navigation. - Revised the API reference and notebook documentation for clearer instructions and improved readability. - Added a new stability test category in the tests index for better organization of testing resources. - Refactored imports in the suite.py file for better code organization and readability.
- Changed pygments style from "github-dark" to "default" for improved readability. - Updated pygments dark style from "material" to "native" for better visual consistency.
- Revised README to enhance descriptions of Giskard's capabilities and integration with tools. - Updated installation instructions in notebooks to reflect changes in library imports and dependencies. - Removed outdated references to foundational models in various notebooks for accuracy. - Standardized the use of `langchain-openai` across examples for consistency. - Improved code organization by removing redundant imports and ensuring proper execution counts.
- Updated the pre-commit configuration to activate the ggshield hook by removing the `skip: true` line. - Ensured proper formatting by maintaining the newline at the end of the file.
- Modified the pip installation command to include additional dependencies: `scipy`, `transformers`, and `torch`, ensuring all necessary libraries are installed for the notebook's functionality.
Member
Author
|
@henchaves Feel free to take a look. |
henchaves
requested changes
Apr 14, 2025
Co-authored-by: Henrique Chaves <44180294+henchaves@users.noreply.github.com>
- Modified pip installation commands in various notebooks and the README to include `langchain` and `langchain-community` for improved functionality and consistency.
- Updated the mathematical notation in the smoothness test docstring for better readability and understanding.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes [GSK-4027]
Closes [GSK-2315]
Closes [GSK-4268]
Closes [GSK-4269]
Description
NA
Related Issue
NA
Type of Change
Checklist
CODE_OF_CONDUCT.mddocument.CONTRIBUTING.mdguide.pdm.lockrunningpdm update-lock(only applicable whenpyproject.tomlhas beenmodified)