-
Notifications
You must be signed in to change notification settings - Fork 300
Model Export to liteRT #2405
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
base: master
Are you sure you want to change the base?
Model Export to liteRT #2405
Conversation
This reverts commit 62d2484.
This reverts commit de830b1.
Refactored exporter and registry logic for better type safety and error handling. Improved input signature methods in config classes by extracting sequence length logic. Enhanced LiteRT exporter with clearer verbose handling and stricter error reporting. Registry now conditionally registers LiteRT exporter and extends export method only if dependencies are available.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @pctablet505, 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 introduces a comprehensive and extensible framework for exporting Keras-Hub models to various formats, with an initial focus on LiteRT. The system is designed to seamlessly integrate with Keras-Hub's model architecture, particularly by addressing the unique challenge of handling dictionary-based model inputs during the export process. This enhancement significantly improves the deployability of Keras-Hub models by providing a standardized and robust export pipeline, alongside crucial compatibility fixes for TensorFlow's SavedModel/TFLite export mechanisms.
Highlights
- New Model Export Framework: Introduced a new, extensible framework for exporting Keras-Hub models, designed to support various formats and model types.
- LiteRT Export Support: Added specific support for exporting Keras-Hub models to the LiteRT format, verified for models like gemma3, llama3.2, and gpt2.
- Registry-Based Configuration: Implemented an
ExporterRegistry
to manage and retrieve appropriate exporter configurations and exporters based on model type and target format. - Input Handling for Keras-Hub Models: Developed a
KerasHubModelWrapper
to seamlessly convert Keras-Hub's dictionary-based inputs to the list-based inputs expected by the underlying Keras LiteRT exporter. - TensorFlow Export Compatibility: Added compatibility shims (
_get_save_spec
and_trackable_children
) to Keras-HubBackbone
models to ensure proper functioning with TensorFlow's SavedModel and TFLite export utilities. - Automated Export Method Extension: The
Task
class in Keras-Hub models is now automatically extended with anexport
method, simplifying the model export process for users.
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
-
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. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a significant new feature: model exporting to liteRT
. The implementation is well-structured, using a modular and extensible registry pattern. However, there are several areas that require attention. The most critical issue is the complete absence of tests for the new export functionality, which is a direct violation of the repository's style guide stating that testing is non-negotiable. Additionally, I've identified a critical bug in the error handling logic within the lite_rt.py
exporter that includes unreachable code. There are also several violations of the style guide regarding the use of type hints in function signatures across all new files. I've provided specific comments and suggestions to address these points, which should help improve the robustness, maintainability, and compliance of this new feature.
try: | ||
# Export using the Keras exporter | ||
keras_exporter.export(filepath) | ||
|
||
if self.verbose: | ||
print(f"Export completed successfully to: {filepath}.tflite") | ||
|
||
except Exception as e: | ||
raise RuntimeError(f"LiteRT export failed: {e}") from e | ||
keras_exporter.export(filepath) | ||
|
||
if self.verbose: | ||
print(f"✅ Export completed successfully!") | ||
print(f"📁 Model saved to: {filepath}.tflite") | ||
|
||
except Exception as e: | ||
if self.verbose: | ||
print(f"❌ Export failed: {e}") | ||
raise |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The try...except
block for the export process contains a bug. The code from line 102 is unreachable due to the raise
statement on line 101. Additionally, having two consecutive except Exception as e:
blocks is a syntax error. The error handling logic should be corrected to properly handle exceptions and report success or failure.
try: | |
# Export using the Keras exporter | |
keras_exporter.export(filepath) | |
if self.verbose: | |
print(f"Export completed successfully to: {filepath}.tflite") | |
except Exception as e: | |
raise RuntimeError(f"LiteRT export failed: {e}") from e | |
keras_exporter.export(filepath) | |
if self.verbose: | |
print(f"✅ Export completed successfully!") | |
print(f"📁 Model saved to: {filepath}.tflite") | |
except Exception as e: | |
if self.verbose: | |
print(f"❌ Export failed: {e}") | |
raise | |
try: | |
# Export using the Keras exporter | |
keras_exporter.export(filepath) | |
if self.verbose: | |
print(f"Export completed successfully to: {filepath}.tflite") | |
except Exception as e: | |
if self.verbose: | |
print(f"❌ Export failed: {e}") | |
raise RuntimeError(f"LiteRT export failed: {e}") from e |
keras_hub/src/export/base.py
Outdated
) | ||
|
||
@abstractmethod | ||
def _is_model_compatible(self) -> bool: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The style guide specifies that type hints should not be used in function signatures 1. Instead, type information should be provided in the Args
section of the docstring. This rule is violated throughout the new files. For example, _is_model_compatible(self) -> bool:
. Please remove type hints from all function signatures in this file and ensure the types are documented in the docstrings.
Style Guide References
Footnotes
-
KerasHub does not use type hints in function signatures. Type information should be provided in the docstring. ↩
keras_hub/src/export/configs.py
Outdated
EXPECTED_INPUTS = ["token_ids", "padding_mask"] | ||
DEFAULT_SEQUENCE_LENGTH = 128 | ||
|
||
def _is_model_compatible(self) -> bool: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to other new files, this file uses type hints in function signatures (e.g., _is_model_compatible(self) -> bool:
), which is against the style guide 1. Please remove the type hints from function signatures and move the type information to the docstrings.
Style Guide References
Footnotes
-
KerasHub does not use type hints in function signatures. Type information should be provided in the docstring. ↩
keras_hub/src/export/configs.py
Outdated
def _get_sequence_length(self) -> int: | ||
"""Get sequence length from model or use default.""" | ||
if hasattr(self.model, 'preprocessor') and self.model.preprocessor: | ||
return getattr(self.model.preprocessor, 'sequence_length', self.DEFAULT_SEQUENCE_LENGTH) | ||
return self.DEFAULT_SEQUENCE_LENGTH |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The _get_sequence_length
method is duplicated across CausalLMExporterConfig
, TextClassifierExporterConfig
, Seq2SeqLMExporterConfig
, and TextModelExporterConfig
. To improve maintainability and reduce code duplication, this method should be moved to the base class KerasHubExporterConfig
in keras_hub/src/export/base.py
.
keras_hub/src/export/lite_rt.py
Outdated
def __init__(self, config: KerasHubExporterConfig, | ||
max_sequence_length: Optional[int] = None, | ||
aot_compile_targets: Optional[list] = None, | ||
verbose: bool = False, | ||
**kwargs): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file uses type hints in function signatures (e.g., __init__(self, config: KerasHubExporterConfig, ...)
), which is against the style guide 1. Please remove the type hints and move the type information to the docstrings.
Style Guide References
Footnotes
-
KerasHub does not use type hints in function signatures. Type information should be provided in the docstring. ↩
keras_hub/src/export/registry.py
Outdated
pass | ||
|
||
|
||
def export_model(model, filepath: str, format: str = "lite_rt", **kwargs): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file uses type hints in function signatures (e.g., export_model(model, filepath: str, ...)
), which is against the style guide 1. Please remove the type hints and move the type information to the docstrings.
Style Guide References
Footnotes
-
KerasHub does not use type hints in function signatures. Type information should be provided in the docstring. ↩
**kwargs: Additional arguments passed to the exporter | ||
""" | ||
# Ensure registry is initialized | ||
initialize_export_registry() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
except ImportError as e: | ||
print(f"⚠️ Failed to import Keras-Hub export functionality: {e}") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using print
for warnings is not ideal as it doesn't give developers control over the message. It's better practice to use warnings.warn
to log this failure. This allows users of the library to filter or redirect warnings as needed.
except ImportError as e: | |
print(f"⚠️ Failed to import Keras-Hub export functionality: {e}") | |
except ImportError as e: | |
import warnings | |
warnings.warn(f"⚠️ Failed to import Keras-Hub export functionality: {e}") |
Introduces the keras_hub.api.export submodule and updates the main API to expose it. The new export module imports various exporter configs and functions from the internal export package, making them available through the public API.
Added ImageClassifierExporterConfig, ImageSegmenterExporterConfig, and ObjectDetectorExporterConfig to the export API. Improved input shape inference and dummy input generation for image-related exporter configs. Refactored LiteRTExporter to better handle model type checks and input signature logic, with improved error handling for input mapping.
Moved the 'import keras' statement to the top of the module and removed redundant local imports within class methods. This improves code clarity and avoids repeated imports.
Deleted the debug_object_detection.py script, which was used for testing object detection model outputs and export issues. This cleanup removes unused debugging code from the repository.
Renames all references of 'LiteRT' to 'Litert' across the codebase, including file names, class names, and function names. Updates exporter registry and API imports to use the new 'litert' naming. Also improves image model exporter configs to dynamically determine input dtype from the model, enhancing flexibility for different input types. Adds support for ImageSegmenter model type detection in the exporter registry.
Added support for model export, currently able to convert gemma3, llama3.2, gpt2 models, and verified numerics also.
Colab Notebook
(https://colab.research.google.com/gist/pctablet505/45a48c42fa91cc27995cdaefda57cb28/model-export.ipynb)