Skip to content

Document LLM features #510

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

nrichers
Copy link
Collaborator

@nrichers nrichers commented Nov 6, 2024

Internal Notes for Reviewers

This PR includes information about:

  • Our philosophy on using LLMs
  • A short explanation of the four features
  • Information about accessing our policies
  • Requesting a demo
  • Related screenshots

I'd be interested to hear if we should change the title to something that has "GenAI" or "AI" in it.

LIVE PREVIEW 🧶

External Release Notes

{{< var vm.product >}} offers several specialized features that use large language models (LLMs) to streamline model risk management and ensure regulatory compliance. Here's how we approach these features and what you need to know: Large language model features

@nrichers nrichers added the documentation Improvements or additions to documentation label Nov 6, 2024
Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 6, 2024

PR Summary

This pull request introduces several enhancements and new features to the project:

  1. Preview Functionality Enhancements:

    • The CSS for the .preview class has been updated to remove fixed width and height, allowing for more flexible sizing.
    • The Lua script handling the preview functionality has been enhanced to:
      • Accept optional width and height attributes, defaulting to 400 and 225 respectively if not specified.
      • Determine if source and target are external URLs and handle them accordingly.
      • Generate HTML content for the preview div with inline width and height, ensuring the iframe scales to 100% of the div's dimensions.
  2. Introduction of LLM Features Documentation:

    • A new documentation file overview-llm-features.qmd has been added, detailing the large language model (LLM) features offered by the product.
    • The documentation covers various aspects such as test interpretation, risk assessment, qualitative checks, and document checker functionalities.
    • It emphasizes the philosophy of using the company's own products for risk management and compliance.
    • The site configuration has been updated to include a link to this new documentation in the navigation menu.
  3. New Media Assets:

    • Several new media files have been added to support the LLM features documentation, including images and a GIF.

These changes aim to enhance the flexibility of the preview feature and provide comprehensive documentation on the LLM capabilities of the product.

Test Suggestions

  • Test the preview functionality with different width and height attributes to ensure the iframe scales correctly.
  • Verify that external URLs for source and target are handled properly in the preview.
  • Check the default behavior of the preview when width and height are not specified.
  • Review the new LLM features documentation for accuracy and completeness.
  • Ensure that the new navigation link to the LLM features documentation works correctly.

Copy link
Contributor

github-actions bot commented Nov 6, 2024

PR Summary

This pull request introduces several enhancements and new features to the project:

  1. Preview Functionality Enhancements:

    • The CSS for the .preview class has been updated to remove fixed width and height, allowing for more flexible sizing.
    • The Lua script for handling preview divs has been enhanced to:
      • Accept optional width and height attributes, defaulting to 400 and 225 respectively if not specified.
      • Determine if source and target attributes are external URLs and handle them accordingly.
      • Generate HTML content for the preview div with inline width and height, ensuring the iframe scales to 100% of the div's dimensions.
  2. Addition of LLM Features Documentation:

    • A new documentation file overview-llm-features.qmd has been added, detailing the large language model (LLM) features offered by the product.
    • The documentation includes sections on test interpretation, risk assessment, qualitative checks, and document checker features, highlighting their importance and functionality.
    • The site navigation has been updated to include a link to the new LLM features documentation.

These changes aim to improve the flexibility and functionality of the preview feature and provide comprehensive documentation on the LLM capabilities of the product.

Test Suggestions

  • Test the preview functionality with different width and height attributes to ensure the iframe scales correctly.
  • Verify that external URLs for source and target attributes are handled properly in the preview.
  • Check the default behavior of the preview when width and height are not specified.
  • Review the new LLM features documentation for accuracy and completeness.
  • Ensure the new navigation link to the LLM features documentation works correctly.

@validbeck
Copy link
Collaborator

@nrichers Played around with the styling some.

  • New .feature class for a different type of callout.
  • I still think the grid cards work better for the What's next section as opposed to the table. We use the card format as a CTA across the site, so I personally thinks it just looks a bit more uniform. The other option would be to do some columns with some CTA .buttons like we do in our releases...

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

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.

Content looks good to me! 🎉

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Collaborator

Why is there weird whitespace on the right in the previews? 🤔

Screenshot 2024-11-06 at 2 51 26 PM

@nrichers
Copy link
Collaborator Author

nrichers commented Nov 6, 2024

Why is there weird whitespace on the right in the previews? 🤔

Interesting, I do not see that in my local preview. It's possible the horizontal Tachyons CSS directive for padding is affecting this, will look into it. Here's what I see:

image

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

@nrichers
Copy link
Collaborator Author

nrichers commented Nov 6, 2024

If it is a "bug", it's a Quarto level bug, not something we introduced with the styling. We'd have to hack it at the Quarto rendering level, not the CSS level. Feel free to prove me wrong, but I spent a few hours fiddling with it and the version we have is the best we got so far. For example...

Actually, I think you put your finger on it ... Either an image in the margins OR a footnote will trigger this behavior. I noticed some janky behaviour with footnotes in responsive columns as well where they will mess up (very technical, I know) the layout. I had to use an inline link to work around this issue.

My apologies to you Beck. Your changes that introduced .attn are not the issue. I appreciate the time you took to explain this further.

For now, I've worked around this issue by moving the footnote out of the "Philosophy" section and moving the image into a column inside of .attn. The end result actually looks decent:

image

BTW, I don't know if you noticed this, but lightbox: auto enables you to have popups for images that let you see the full size. This is the first time we've used it as far as I can tell, but it's helpful with images that have a lot of detail, like the ValidChecker.

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

1 similar comment
Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Collaborator

My apologies to you Beck. Your changes that introduced .attn are not the issue. I appreciate the time you took to explain this further.

I do agree that ideally Quarto would not apply the dang styling to the full right half whenever there is margin content, and instead just what they call the body + margins, but for some reason anytime there is margin content it decides to go wild. It doesn't bother me too much (because my screen is not large enough at maximize for me to care), but it might be worth it to log a ticket with the Quarto peeps?

BTW, I don't know if you noticed this, but lightbox: auto enables you to have popups for images that let you see the full size. This is the first time we've used it as far as I can tell, but it's helpful with images that have a lot of detail, like the ValidChecker.

I did note that, and I don't think it needs to be on for both images though I don't know why GitHub put my comment for that somewhere else instead of as a review comment. 💀

@nrichers
Copy link
Collaborator Author

nrichers commented Nov 6, 2024

I did note that, and I don't think it needs to be on for both images though I don't know why GitHub put my comment for that somewhere else instead of as a review comment. 💀

It's enabled at the page level, so it's either all or nothing. The animated GIF is kinda hard to read without the lightbox treatment and so ...

@validbeck
Copy link
Collaborator

It's enabled at the page level, so it's either all or nothing. The animated GIF is kinda hard to read without the lightbox treatment and so ...

You don't need to enable it at the page level. For example:

![Document checker in progress](overview-llm-features-check-document-in-progress.gif){fig-alt="A screenshot showing the LLM feature for checking documents that can be accessed with the Check Document button" class="screenshot" .lightbox}

Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

1 similar comment
Copy link
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

Copy link
Collaborator

@kristof87 kristof87 left a comment

Choose a reason for hiding this comment

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

This looks great. I really like how you are presenting this content.

Copy link
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@nrichers nrichers merged commit 8d6ba5c into main Nov 7, 2024
3 checks passed
@nrichers nrichers deleted the nrichers/sc-6909/document-model-documentation-for-validmind branch November 7, 2024 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants