Skip to content
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.

Sign up for GitHub

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

add compile_method flag and add other framework artifact types #40

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

add compile_method flag and add other framework artifact types #40

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
15b293c
wip adding tensorflow artifact types, remove torch.compile
rbavery Oct 30, 2024
b4885f6
update TF/Keras formats using the saving method as the artifact type
rbavery Dec 12, 2024
4611cb3
Merge branch 'main' into separate_compile_method_from_artifact
rbavery Dec 13, 2024
2c63d5e
move framework specific fields to best practices
rbavery Dec 13, 2024
3cb4e05
edit line length
rbavery Dec 13, 2024
4c1c63a
update json schema, note when the mlm:artifact type is required by ml…
rbavery Dec 13, 2024
357ad61
lint fixes
rbavery Dec 13, 2024
b54dd11
CHANGELOG updates
rbavery Dec 13, 2024
2c3c44e
correct the deleted unreleased items in the CHANGELOG, woops
rbavery Dec 13, 2024
66ca180
correct best practices links, be more specific in table descriptions
rbavery Dec 13, 2024
d770629
code ticks
rbavery Dec 16, 2024
3a3d262
fix line length
rbavery Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,17 +657,24 @@ the users understand the source explicitly, although this is not strictly requir

| Artifact Type | Description |
|--------------------|--------------------------------------------------------------------------------------|
| `torch.save` | A model artifact obtained by [Serialized Pickle Object][pytorch-save] (i.e.: `.pt`). |
| `torch.jit.script` | A model artifact obtained by [`TorchScript`][pytorch-jit-script]. |
| `torch.export` | A model artifact obtained by [`torch.export`][pytorch-export] (i.e.: `.pt2`). |
| `torch.compile` | A model artifact obtained by [`torch.compile`][pytorch-compile]. |
| `torch.save` | A [serialized python pickle object][pytorch-save] (i.e.: `.pt`) which can represent a model or state_dict. |
rbavery marked this conversation as resolved.
Show resolved Hide resolved
| `torch.jit.save` | A [`TorchScript`][pytorch-jit-script] model artifact obtained with one or more of the graph export options Torchscript Tracing and Torchscript Scripting. |
rbavery marked this conversation as resolved.
Show resolved Hide resolved
| `torch.export.save` | A model artifact storing an ExportedProgram obtained by [`torch.export.export`][pytorch-export] (i.e.: `.pt2`). |
rbavery marked this conversation as resolved.
Show resolved Hide resolved
| `TFSavedModel` | A [SavedModel][tf-save] from Tensorflow or Keras. |
rbavery marked this conversation as resolved.
Show resolved Hide resolved
| `Keras_v3` | Keras v3 is the [recommended format][keras-recommended] by the Tensorflow team. See this example to [save and load models][keras-example] and the update to date docs [disambiguating different save methods][keras-methods] in TF and Keras.. |
rbavery marked this conversation as resolved.
Show resolved Hide resolved
| `h5` | [Keras and tf.keras model][h5] weights format, which uses HDF5. |
rbavery marked this conversation as resolved.
Show resolved Hide resolved

[pytorch-compile]: https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html
[pytorch-export]: https://pytorch.org/docs/main/export.html
[pytorch-frameworks]: https://pytorch.org/docs/main/export.html#existing-frameworks
[pytorch-aot-inductor]: https://pytorch.org/docs/main/torch.compiler_aot_inductor.html
[pytorch-jit-script]: https://pytorch.org/docs/stable/jit.html
[pytorch-save]: https://pytorch.org/tutorials/beginner/saving_loading_models.html
[tf-save]: https://www.tensorflow.org/guide/saved_model
[keras-example]: https://keras.io/guides/serialization_and_saving/
[keras-recommended]: https://www.tensorflow.org/guide/saved_model#creating_a_savedmodel_from_keras
rbavery marked this conversation as resolved.
Show resolved Hide resolved
[h5]: https://keras.io/api/models/model_saving_apis/weights_saving_and_loading/
rbavery marked this conversation as resolved.
Show resolved Hide resolved
[keras-methods]: https://keras.io/2.16/api/models/model_saving_apis/model_saving_and_loading/

### Source Code Asset

Expand Down
Loading