-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add script to regenerate
catalog_upload.json files (#200)
* Add script to regenerate catalog_upload.json files Add helper script to regenerate the catalog_upload.json file(s) from the *.yaml files that are found inside the locally cloned katalog repo. Regenerate files: - bootstrapper/catalog_upload.json - quickstart/catalog_upload.json Current caveats: - no documentation yet - no command parameters, no command line help - the user must have cloned the katalog repo and the mlx repo in the same parent folder (in the future those paths should be configurable as parameters) - not all of the YAML files in the katalog repo may want to be included in the catalog upload, so after the files get regenerated, the user (MLX maintainer) needs to exercise some judgment - assets that live outside the katalog repo will not be found and have to be re-added (or not removed) using a Git enabled IDE or git diff tool - this initial commit reorders some of the assets (based on filename) Signed-off-by: Christian Kadner <[email protected]> * Filter out "template", "src", "test" Signed-off-by: Christian Kadner <[email protected]> * Update after Qiskit, CodeNet, MAX katalog changes Signed-off-by: Christian Kadner <[email protected]>
- Loading branch information
Showing
3 changed files
with
245 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # Copyright 2021 IBM Corporation | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from __future__ import print_function | ||
|
|
||
| import json | ||
| import yaml | ||
|
|
||
| from glob import glob | ||
| from os.path import abspath, dirname, relpath | ||
|
|
||
|
|
||
| asset_types = [ | ||
| "component", | ||
| "dataset", | ||
| "model", | ||
| "notebook", | ||
| "pipeline", | ||
| ] | ||
|
|
||
| script_path = abspath(dirname(__file__)) | ||
| project_dir = dirname(script_path) | ||
|
|
||
| katalog_dir = f"{project_dir}/../katalog" # TODO: don't assume user cloned katalog and mlx repos into same parent folder | ||
| katalog_url = "https://raw.githubusercontent.com/machine-learning-exchange/katalog/main/" | ||
|
|
||
| catalog_upload_json_files = [ | ||
| f"{project_dir}/bootstrapper/catalog_upload.json", | ||
| f"{project_dir}/quickstart/catalog_upload.json", | ||
| ] | ||
|
|
||
|
|
||
| def get_list_of_yaml_files_in_katalog(asset_type: str): | ||
|
|
||
| yaml_files = glob(f"{katalog_dir}/{asset_type}-samples/**/*.yaml", recursive=True) | ||
|
|
||
| yaml_files = [filepath for filepath in yaml_files | ||
| if not any(word in filepath for word in ["template", "test", "src"])] | ||
|
|
||
| return sorted(yaml_files) | ||
|
|
||
|
|
||
| def generate_katalog_dict() -> dict: | ||
|
|
||
| katalog_dict = dict() | ||
|
|
||
| for asset_type in asset_types: | ||
|
|
||
| yaml_files = get_list_of_yaml_files_in_katalog(asset_type) | ||
| katalog_asset_list = [] | ||
|
|
||
| for yaml_file in yaml_files: | ||
|
|
||
| with open(yaml_file) as f: | ||
| yaml_dict = yaml.load(f, Loader=yaml.FullLoader) | ||
| asset_name = yaml_dict.get("name") or \ | ||
| yaml_dict.get("metadata", {}).get("name", "").replace("-", " ").title() \ | ||
| or "" | ||
| asset_url = katalog_url + relpath(yaml_file, katalog_dir) | ||
|
|
||
| katalog_asset_item = { | ||
| "name": asset_name, | ||
| "url": asset_url | ||
| } | ||
|
|
||
| katalog_asset_list.append(katalog_asset_item) | ||
|
|
||
| katalog_dict[asset_type + "s"] = katalog_asset_list | ||
|
|
||
| return katalog_dict | ||
|
|
||
|
|
||
| def rewrite_catalog_upload_json_files(katalog: dict): | ||
|
|
||
| for file_path in catalog_upload_json_files: | ||
|
|
||
| with open(file_path, "w") as output_file: | ||
|
|
||
| print(" - " + relpath(file_path, project_dir)) | ||
|
|
||
| output_file.write(json.dumps(katalog, sort_keys=False, indent=2)) | ||
| output_file.write("\n") | ||
|
|
||
|
|
||
| def main(): | ||
|
|
||
| print("Regenerating catalog_upload.json files:") | ||
|
|
||
| # TODO: read current catalog_upload.json file(s) to capture non-katalog assets and restore later | ||
|
|
||
| katalog_dict = generate_katalog_dict() | ||
|
|
||
| rewrite_catalog_upload_json_files(katalog_dict) | ||
|
|
||
| print("Done. Use git diff to evaluate if and which changes are desired!") | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
|
|
||
| main() |
Oops, something went wrong.