Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Release notes to sprint 55#270

Merged
validbeck merged 6 commits intomainvalidmind/documentation:mainfrom
noosheenvazinkhoo/sc-5549/release-notes-to-sprint-55validmind/documentation:noosheenvazinkhoo/sc-5549/release-notes-to-sprint-55Copy head branch name to clipboard
Aug 15, 2024
Merged

Release notes to sprint 55#270
validbeck merged 6 commits intomainvalidmind/documentation:mainfrom
noosheenvazinkhoo/sc-5549/release-notes-to-sprint-55validmind/documentation:noosheenvazinkhoo/sc-5549/release-notes-to-sprint-55Copy head branch name to clipboard

Conversation

@noosheenv
Copy link
Contributor

Internal Notes for Reviewers

I did some release notes!
This was generated using the notebook in another branch, so I copied the files over to this branch.
You can find this in ~/site/releases/2024-aug-13

image

External Release Notes

@noosheenv noosheenv added the internal Not to be externalized in the release notes label Aug 9, 2024
@noosheenv noosheenv requested review from nrichers and validbeck August 9, 2024 17:05
@noosheenv noosheenv self-assigned this Aug 9, 2024
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

Nice work pulling these together!

  • Right under the Release highlights heading, you need to summarize the whole release in 250 characters or less. ;) (They will eventually get pulled into a yearly releases, which uses our listings...)
  • It looks like you didn't manage to adjust the columns to actually stack side-by-side for some of these, so give that another go.
  • Some of the wording needs a visit from the grammar fairy (as Nik calls it). For example, "You need" > You'll need etc. There are some incomplete sentences without punctuation as well.

@noosheenv
Copy link
Contributor Author

Thanks for the feedback! Here are my edits:
Oh my god the column thing wasn't working because I didn't add filters: tachyons to the frontmatter 🙄 silly me.
For the summary, I just followed the vibe of the March 27, 2024 release, because the newer ones don't have one.
Grammar hopefully fixed now!

@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements and bug fixes to the ValidMind platform, including new customization options for the dashboard, generalized support for comparison tests, improvements to the reports page, and the ability to manage model dependencies. Additionally, it addresses a bug related to outlier tests and updates the documentation to include support for Google Cloud Private Service Connect.

Key Changes

Customize Your Dashboard

  • Enhanced the ValidMind Dashboard with new customization options, allowing users to rearrange and resize widgets and add charts from the Reports section.

Generalize Support for Comparison Tests

  • Added support to specify an input grid for comparison tests with multiple datasets or models, making it easier to analyze results.

Reports Page Improvements

  • Added new summary widgets to the Reports tab, including Total Models, Total Findings, Open Findings, Past Due Findings, and Closed Findings.

Manage Model Dependencies

  • Introduced the ability to configure and manage model dependencies in the Model Inventory, including both upstream and downstream interdependencies.

Bug Fix: Exclude Categorical & Binary Features from Outlier Tests

  • Excluded categorical and binary features from the outlier tests IQROutliersTable and IQROutliersBarPlot to improve computational efficiency and relevance of insights.

Documentation: Support for GCP Private Service Connect

  • Added support for Google Cloud Private Service Connect, enhancing network security and privacy by allowing private connections between ValidMind and company networks without exposing traffic to the public internet.

Test Suggestions

  • Test the new dashboard customization features by rearranging and resizing widgets and adding charts from the Reports section.
  • Run comparison tests with multiple datasets and models to verify the new input grid support.
  • Verify the new summary widgets on the Reports tab display accurate information for Total Models, Total Findings, Open Findings, Past Due Findings, and Closed Findings.
  • Test the model dependency management feature by configuring and managing both upstream and downstream dependencies.
  • Ensure that categorical and binary features are correctly excluded from the IQROutliersTable and IQROutliersBarPlot outlier tests.
  • Verify the functionality of Google Cloud Private Service Connect by establishing a private connection and ensuring secure communication without exposing traffic to the public internet.

@validbeck
Copy link
Collaborator

@noosheenv I can't approve this PR unless you re-request review. ;)

Either way, here are some changes I made that you should take note of:

  • Updated the summary for the release missing the summary (July 22, 2024) & added both newer releases to 2024-releases.qmd (Remember the scout philosophy of leaving things better than you found them?)
  • For Aug 13, 2024:
    • Adjusted the layout of some sections to be a bit more streamlined
    • Edited text for accuracy clarity and context (this is important!!)
    • Removed the period at the end of alt text (general style convention — unless it is a complete sentence, no punctuation is needed for UI elements)
Old New Details
Screenshot 2024-08-13 at 10 48 17 AM Screenshot 2024-08-13 at 10 43 52 AM Summaries need to both be more broad and more descriptive. Context is important — Make sure you refer to UI elements users can interact with for reference, and provide any supplementary information. Get rid of the modal verb ("you can") and simply use the imperative ("do [x]"); you're inciting a call to action! When we use columns, they're to enhance the layout, not just to offset items.
Screenshot 2024-08-13 at 10 52 40 AM Screenshot 2024-08-13 at 10 43 59 AM Again, provide context (links are great). Removed the important callout class, as this isn't a warning — it's just information.
Screenshot 2024-08-13 at 10 54 39 AM Screenshot 2024-08-13 at 10 44 06 AM Make sure when you reference UI elements you follow the casing you see in the UI. Always include more context — why is this feature relevant or useful to users?
Screenshot 2024-08-13 at 10 56 32 AM Screenshot 2024-08-13 at 10 44 16 AM Cleanup here for layout. This section also would have benefitted from you digging into the feature a little to understand what you're describing. I've made the necessary edits to the filename/descriptions.
Screenshot 2024-08-13 at 10 57 48 AM Screenshot 2024-08-13 at 11 01 13 AM Your bug fix really needed context — what is this referring to (the links) and why was it important that this bug was fixed? Section headers really needed some work too; they should succinctly summarize but not be too wordy.

Note: When you publish these to prod as per the process, make sure you run make get-source as we are missing some notebooks that are on the developer-framework repo on main:

WARN: Unable to resolve link target: notebooks/how_to/run_tests/2_run_comparison_tests.ipynb

@validbeck validbeck merged commit 0998fe1 into main Aug 15, 2024
@validbeck validbeck deleted the noosheenvazinkhoo/sc-5549/release-notes-to-sprint-55 branch August 15, 2024 16:25
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

Morty Proxy This is a proxified and sanitized view of the page, visit original site.