Skip to content

Focoos CLI#111

Merged
CuriousDolphin merged 22 commits into
mainfrom
feat/cli
Jun 30, 2025
Merged

Focoos CLI#111
CuriousDolphin merged 22 commits into
mainfrom
feat/cli

Conversation

@giuseppeambrosio97

Copy link
Copy Markdown
Contributor

No description provided.

- Introduced PREDICT_DIR for model predictions.
- Enhanced RuntimeType with string representation methods.
- Replaced literal types in TrainerArgs with defined type aliases for better readability and maintainability.
- Introduced a new CLI module for Focoos, enabling commands for training, validation, prediction, export, and benchmarking.
- Added comprehensive documentation for CLI usage, including command options and examples.
- Updated project configuration files to include the new CLI dependencies and scripts.
- Enhanced the mkdocs navigation to include CLI documentation.
- Expanded the documentation for the Focoos CLI, detailing command functionalities, usage examples, and architectural insights.
- Improved the predict, export, benchmark, and train command implementations with enhanced logging and error handling.
- Updated command arguments and descriptions for clarity and consistency across the CLI interface.
- Added support for lazy loading in the CLI to optimize performance and prevent circular dependencies.
- Enhanced the validation command to provide comprehensive evaluation metrics and visualization options.
- Removed the optional models_dir parameter from the ModelManager class and its associated methods to simplify the interface.
- Updated the _from_local_dir method to derive the model directory path directly from the name or default to MODELS_DIR.
- Adjusted error messages to reflect the new logic for model directory resolution.
- Added a TODO comment in the RemoteModel class to address the need for the upload_artifacts parameter to accept a list of artifact names, improving clarity for future development.
- Enhanced the image_loader function to accept image URLs, allowing for direct loading of images from the web.
- Implemented a check for string inputs that start with "http://" or "https://", utilizing the requests library to fetch the image content.
- Updated documentation to reflect the new input type for improved clarity.
…ayout documentation

- Renamed the PREDICT_DIR variable to PREDICTIONS_DIR for clarity and consistency.
- Removed outdated SUPERVISELY format documentation from the DatasetLayout class to streamline the code and improve readability.
- Added a new module for hub-related commands in the Focoos CLI, enabling users to interact with the Focoos Hub.
- Implemented commands to list available pretrained models and datasets, including options for downloading and uploading datasets.
- Enhanced documentation with usage examples and detailed descriptions for each command, improving user experience and clarity.
- Introduced a new documentation file for the Focoos CLI, detailing features, installation instructions, command usage, and configuration options.
- Included extensive examples for training, validation, prediction, and model export commands to enhance user understanding and experience.
- Documented available commands and their parameters, providing a clear reference for users to effectively utilize the CLI.
- Introduced a new section in the README.md to acknowledge contributors, enhancing community recognition.
- Included a visual representation of contributors using a dynamic image link for better engagement.
- Changed the error message in ModelManager to provide clearer feedback when a run directory is not found.
- Removed references to the SUPERVISELY layout from DatasetLayout and AutoDataset classes to streamline the code and improve clarity.
- Changed the example command for uploading a dataset to specify a .zip file.
- Improved descriptions for available subcommands and added notes regarding internet connection and API key requirements.
- Clarified that a dataset must be created on the Focoos Hub before uploading.
- Incremented the revision number to 2.
- Updated resolution markers to use 'sys_platform' instead of 'platform_system'.
- Added 'upload-time' metadata for several packages in the lock file to improve tracking of package updates.
- Modified examples in concepts.md to reflect the new model loading syntax, specifying full paths for models.
- Added a new section in cli.py for Focoos Hub commands, including examples for hub-related operations.
- Removed unnecessary models_dir parameters from benchmark and predict commands, simplifying the API.
- Updated hub.py documentation to link to relevant dataset structure guidelines.
- Updated documentation to specify the requirement of a Focoos API Key in the environment variable `FOCOOS_API_KEY` for various hub commands.
- Reformatted notes for clarity and consistency across model and dataset commands.
- Commented out the sync command implementation as a placeholder for future development.
- Updated the artifact upload logic to accept a customizable list of artifact names instead of a fixed set.
- Added a warning log for missing artifacts to enhance error tracking during uploads.
- Cleaned up the code for better readability and maintainability.
@giuseppeambrosio97 giuseppeambrosio97 self-assigned this Jun 30, 2025
@giuseppeambrosio97 giuseppeambrosio97 changed the title Feat/cli Focoos CLI Jun 30, 2025
@github-actions

github-actions Bot commented Jun 30, 2025

Copy link
Copy Markdown

Coverage

Tests Skipped Failures Errors Time
221 0 💤 0 ❌ 0 🔥 15.947s ⏱️

- Refactored the test case to use a variable for the model path, improving readability and maintainability.
- Ensured that the expected weights URI is constructed using the updated model path variable.
- Updated the model path in the test case to remove the leading slash, ensuring it aligns with expected directory structure.
- This change enhances the accuracy of the test by reflecting the correct relative path for model loading.
- Refactored the run directory validation logic to streamline the process of checking for model existence.
- Updated the error handling to provide clearer feedback when a specified run directory does not exist.
- Adjusted the corresponding test case to reflect the changes in error message expectations.
@CuriousDolphin CuriousDolphin merged commit 1735dc5 into main Jun 30, 2025
10 checks passed
@CuriousDolphin CuriousDolphin deleted the feat/cli branch June 30, 2025 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants