feat(docs): add CLAUDE.md for project guidance and development instru… #148
Conversation
…ctions - Introduced CLAUDE.md to provide comprehensive guidance for the VLM Run Python SDK, including project overview, development commands, architecture details, configuration, optional dependencies, testing, and code style. - Updated version to 0.5.2 in version.py. - Modified CLI credential check to skip for config commands in cli.py.
Summary of ChangesHello @shahrear33, I'm Gemini Code Assist1! 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 enhances the developer experience by introducing a detailed CLAUDE.md documentation file, which serves as a comprehensive guide for understanding and contributing to the VLM Run Python SDK. Additionally, it includes a minor version bump and improves the command-line interface usability by allowing configuration commands to run without prior API credential validation. Highlights
🧠 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 AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a CLAUDE.md file to guide AI-assisted development, updates the CLI to allow configuration without prior credential checks, and bumps the project version. The changes are well-implemented and logical. The new CLAUDE.md is comprehensive and provides a great overview of the project. The CLI modification is a necessary fix for setting up credentials. I have one suggestion for the CLAUDE.md file to improve consistency with the codebase's naming conventions, which will enhance clarity for both human developers and AI assistants.
| - **Resource Classes** - Each API domain has its own resource class: | ||
| - `ImagePredictions`, `DocumentPredictions`, `VideoPredictions`, `AudioPredictions` (`predictions.py`) | ||
| - `Agent` (`agent.py`) - Also provides OpenAI-compatible completions interface via `client.agent.completions` | ||
| - `Files`, `Hub`, `Models`, `Datasets`, `Finetuning`, `Feedback`, `Executions`, `Artifacts` |
There was a problem hiding this comment.
For better clarity and consistency with the client's properties, it would be helpful to list the resource properties using their actual snake_case names as they are accessed on the VLMRun client instance (e.g., client.fine_tuning). The current list uses PascalCase, which are the class names, and Finetuning is inconsistent with the property name fine_tuning.
Using property names will make it clearer for anyone (including an AI assistant) how to access these resources.
| - `Files`, `Hub`, `Models`, `Datasets`, `Finetuning`, `Feedback`, `Executions`, `Artifacts` | |
| - `files`, `hub`, `models`, `datasets`, `fine_tuning`, `feedback`, `executions`, `artifacts` |
1 participant
…ctions