docs: tweak README verbiage and user doc perf section

[g-husam]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @g-husam, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refines the README.md file to enhance clarity and precision regarding the ML checkpointing library's features and usage. The changes aim to provide a more accurate and user-friendly introduction to the project, particularly concerning adapter integration and installation instructions.

Highlights

• Improved Clarity on Adapter Integration: The description of how PyTorch DCP, Megatron-LM, and NeMo 2.0 adapters integrate with the core checkpointing APIs has been rephrased for better understanding.
• Refined Language for Framework Integration: The phrase 'direct integration support' has been updated to 'native integration' to more accurately reflect the type of support being offered for other frameworks.
• Enhanced Adapter Installation Guidance: The instructions for finding adapter installation commands now explicitly point to the pyproject.toml file as the definitive source for available adapters, improving discoverability.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request improves the wording in the README.md file for better clarity and adds a helpful reference to pyproject.toml as the source of truth for available adapters. The changes are good. I've added a couple of minor suggestions to further improve readability by breaking up longer sentences.

[g-husam]

/gemini review

[gemini-code-assist]

Code Review

This pull request refines the wording in the main README.md and the performance section of the user documentation. The changes improve clarity and provide more specific details about performance benefits. I've added a couple of suggestions to the user documentation's performance section to further improve readability and make the comparisons easier to understand. Overall, these are good improvements to the documentation.

[g-husam]

/gemini review

[gemini-code-assist]

Code Review

This pull request refines the wording in the main README.md and the user documentation's README.md. The changes improve clarity, especially in the performance section of the user docs where the comparison of checkpointing strategies is now much clearer. Overall, these are good improvements to the documentation. I have one minor suggestion to further enhance readability in the performance section.