Skip to content

Removed references to projects in Jupyter Notebooks#203

Merged
cachafla merged 5 commits intomainfrom
beck/sc-6401/remove-references-to-projects-in-documentation
Oct 8, 2024
Merged

Removed references to projects in Jupyter Notebooks#203
cachafla merged 5 commits intomainfrom
beck/sc-6401/remove-references-to-projects-in-documentation

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

Internal Notes for Reviewers

As a follow-up to sc-6403, I combed through our Jupyter Notebooks for outdated references to projects instead of models and clarified some terminology.

@validbeck validbeck added the internal Not to be externalized in the release notes label Oct 7, 2024
@validbeck validbeck self-assigned this Oct 7, 2024
@validbeck validbeck requested a review from cachafla October 7, 2024 16:52
Copy link
Copy Markdown
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🙏

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 8, 2024

PR Summary

This pull request introduces several changes across multiple Jupyter notebooks and Python files within the project. The primary focus of these changes is to refactor the terminology from 'project' to 'model' in various contexts, which aligns with the domain-specific language used in the ValidMind platform. This includes updates in code comments, variable names, and documentation strings. Additionally, minor documentation text adjustments were made to improve clarity and consistency.

Key changes include:

  • In application_scorecard_with_bias.ipynb, the parameter project was changed to model in the vm.init() function call.
  • In foundation_models_integration_demo.ipynb and hugging_face_integration_demo.ipynb, the term 'documentation projects' was updated to 'documentation initiatives'.
  • In rag_rfp_answer_generation.ipynb and rag_rfp_answer_generation_langchain.ipynb, the metadata field Project_Title was changed to Model_Title.
  • In test_configuration_updates_demo.ipynb, run_documentation_tests_with_config.ipynb, and intro_for_model_developers.ipynb, the variable project_test_suite was renamed to model_test_suite.

These changes aim to enhance the clarity and consistency of the codebase, making it more intuitive for developers working with model-related functionalities.

Test Suggestions

  • Verify that the refactored variable names and parameters do not break existing functionality.
  • Run all existing unit tests to ensure no regressions have been introduced.
  • Manually test the affected Jupyter notebooks to ensure they execute without errors and produce the expected outputs.
  • Check that the documentation updates are reflected correctly in the rendered markdown cells of the notebooks.

@cachafla cachafla merged commit af18713 into main Oct 8, 2024
@cachafla cachafla deleted the beck/sc-6401/remove-references-to-projects-in-documentation branch October 8, 2024 04:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants