Skip to content

Removed documentation projects from JN #184

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

Conversation

validbeck
Copy link
Collaborator

Internal Notes for Reviewers

For sc-6343 I noticed that there were still some references to "documentation projects" in our Jupyter Notebooks. I removed them or reworded sections to match.

/code_sharing/support_polars_dataset.ipynb

This notebook was SUPER outdated, and looked to be a duplication of of more recent quickstart notebook: https://github.com/validmind/developer-framework/blob/beck/sc-6343/remove-documentation-projects-from-jupyter/notebooks/code_samples/quickstart_customer_churn_full_suite.ipynb

I deleted this, as I believe this is how the confusion for the curated training notebooks happened.

@validbeck validbeck added the internal Not to be externalized in the release notes label Sep 6, 2024
@validbeck validbeck self-assigned this Sep 6, 2024
@validbeck validbeck requested a review from cachafla September 6, 2024 18:45
Copy link
Contributor

github-actions bot commented Sep 6, 2024

PR Summary

This pull request introduces several updates to the documentation references within various Jupyter notebooks and removes an outdated notebook. The changes are as follows:

  1. Documentation Reference Updates:

    • Updated references to the ValidMind platform and documentation templates in multiple notebooks to improve clarity and accuracy.
    • Specific changes include:
      • notebooks/code_samples/customization/customizing_tests_with_output_templates.ipynb: Updated instructions for customizing documentation templates.
      • notebooks/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb: Clarified the use of the vm.run_documentation_tests function.
      • notebooks/code_samples/nlp_and_llm/rag_documentation_demo.ipynb: Improved descriptions for initializing the ValidMind framework and loading datasets.
      • notebooks/code_sharing/credit_risk/assign_prediction_probabilities.ipynb: Updated the description of the documentation template preview.
      • notebooks/how_to/load_datasets_predictions.ipynb, notebooks/how_to/run_documentation_tests_with_config.ipynb, notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb: Updated the description of the documentation template preview.
  2. Notebook Removal:

    • Removed notebooks/code_sharing/support_polars_dataset.ipynb as it is outdated and no longer relevant to the current project structure.

Test Suggestions

  • Run the updated notebooks to ensure that the new documentation references are correct and that the instructions are clear and functional.
  • Verify that the removal of support_polars_dataset.ipynb does not affect any other parts of the project.
  • Check for broken links or references in the remaining notebooks that might have pointed to the removed notebook.

@validbeck validbeck merged commit d62cc1e into main Sep 6, 2024
5 checks passed
@validbeck validbeck deleted the beck/sc-6343/remove-documentation-projects-from-jupyter branch September 6, 2024 23:30
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