Dev modify docs

[4Freye]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @4Freye, 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 primarily focuses on enhancing the project's documentation and refining its build configuration. It introduces descriptive content for the panelsplit.model_selection and panelsplit.metrics modules within the package's initialization file, ensuring these new components are well-documented and properly exposed. Additionally, a minor adjustment has been made to the pyproject.toml file to standardize versioning behavior during package builds.

Highlights

• Documentation Update: New documentation sections have been added to panelsplit/__init__.py for the panelsplit.model_selection and panelsplit.metrics modules, detailing their functionalities.
• Module Exposure: The __all__ list in panelsplit/__init__.py has been updated to explicitly expose the newly documented model_selection and metrics modules.
• Build Configuration: A new configuration option, local_scheme = "no-local-version", has been added to pyproject.toml under [tool.hatch.version.raw-options] to manage version string generation.

🧠 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 updates the package's main __init__.py file to document and export the new model_selection and metrics modules. It also configures hatch in pyproject.toml to produce clean version strings without local identifiers. The changes are straightforward and correct. I have one suggestion to improve code maintainability by sorting the __all__ list.