{"id":13414628,"url":"https://github.com/tensorflow/model-card-toolkit","last_synced_at":"2025-10-05T12:32:02.488Z","repository":{"id":38280400,"uuid":"282271871","full_name":"tensorflow/model-card-toolkit","owner":"tensorflow","description":"A toolkit that streamlines and automates the generation of model cards ","archived":true,"fork":false,"pushed_at":"2023-07-26T12:05:00.000Z","size":9489,"stargazers_count":427,"open_issues_count":9,"forks_count":87,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-01-10T08:33:27.094Z","etag":null,"topics":["deep-learning","machine-learning","model-cards","responsible-ai","responsible-ml","tensorflow","transparency"],"latest_commit_sha":null,"homepage":"https://www.tensorflow.org/responsible_ai/model_card_toolkit/guide","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tensorflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-07-24T16:48:58.000Z","updated_at":"2024-12-02T09:52:14.000Z","dependencies_parsed_at":"2024-01-07T01:44:29.908Z","dependency_job_id":"a771a8b5-4f6c-4e71-b732-ce78ca019a52","html_url":"https://github.com/tensorflow/model-card-toolkit","commit_stats":{"total_commits":240,"total_committers":22,"mean_commits":"10.909090909090908","dds":0.35,"last_synced_commit":"ee1ead6f1d60bba9a7f788671f33795ecdf44fc3"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorflow%2Fmodel-card-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorflow%2Fmodel-card-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorflow%2Fmodel-card-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorflow%2Fmodel-card-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tensorflow","download_url":"https://codeload.github.com/tensorflow/model-card-toolkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235399012,"owners_count":18983814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deep-learning","machine-learning","model-cards","responsible-ai","responsible-ml","tensorflow","transparency"],"created_at":"2024-07-30T21:00:31.554Z","updated_at":"2025-10-05T12:31:56.671Z","avatar_url":"https://github.com/tensorflow.png","language":"Python","readme":"# Model Card Toolkit\n\n[![CI][ci_badge]][ci_link]\n[![PyPI][pypi_badge]][pypi_link]\n[![Documentation][docs_badge]][docs_link]\n\nThe Model Card Toolkit (MCT) streamlines and automates generation of\n[Model Cards](https://modelcards.withgoogle.com/about) [1], machine learning documents\nthat provide context and transparency into a model's development and performance.\nIntegrating the MCT into your ML pipeline enables you to share model metadata and\nmetrics with researchers, developers, reporters, and more.\n\nSome use cases of model cards include:\n\n* Facilitating the exchange of information between model builders and product developers.\n* Informing users of ML models to make better-informed decisions about how to use them (or how not to use them).\n* Providing model information required for effective public oversight and accountability.\n\n![Generated model card image](https://raw.githubusercontent.com/tensorflow/model-card-toolkit/main/model_card_toolkit/documentation/guide/images/model_card.png)\n\n## Installation\n\nThe Model Card Toolkit is hosted on [PyPI](https://pypi.org/project/model-card-toolkit/),\nand requires Python 3.7 or later.\n\nInstalling the basic, framework agnostic package:\n\n```sh\npip install model-card-toolkit\n```\n\nIf you are generating model cards for TensorFlow models, install the optional\nTensorFlow dependencies to use Model Card Toolkit's TensorFlow utilities:\n\n```sh\npip install model-card-toolkit[tensorflow]\n```\n\nYou may need to append the `--use-deprecated=legacy-resolver` flag when running\nversions of pip starting with 20.3.\n\nSee [the installation guide](model_card_toolkit/documentation/guide/install.md)\nfor more installation options.\n\n## Getting Started\n\n    import model_card_toolkit as mct\n\n    # Initialize the Model Card Toolkit with a path to store generate assets\n    model_card_output_path = ...\n    toolkit = mct.ModelCardToolkit(model_card_output_path)\n\n    # Initialize the ModelCard, which can be freely populated\n    model_card = toolkit.scaffold_assets()\n    model_card.model_details.name = 'My Model'\n\n    # Write the model card data to a proto file\n    toolkit.update_model_card(model_card)\n\n    # Return the model card document as an HTML page\n    html = toolkit.export_format()\n\n## Model Card Generation on TFX\n\nIf you are using [TensorFlow Extended (TFX)](https://www.tensorflow.org/tfx), you can\nincorporate model card generation into your TFX pipeline via the `ModelCardGenerator`\ncomponent.\n\nThe `ModelCardGenerator` component has moved to the\n[TFX Addons](https://github.com/tensorflow/tfx-addons) library and is no longer\npackaged in Model Card Toolkit from version 2.0.0. Before you can use the\ncomponent, you will need to install the `tfx-addons` package:\n\n```sh\npip install tfx-addons[model_card_generator]\n```\n\nSee the [ModelCardGenerator guide](https://github.com/tensorflow/tfx-addons/blob/main/tfx_addons/model_card_generator/README.md)\nand run the [case study notebook](https://github.com/tensorflow/tfx-addons/blob/main/examples/model_card_generator/MLMD_Model_Card_Toolkit_Demo.ipynb)\nto learn more about the component.\n\n## Schema\n\nModel cards are stored in proto as an intermediate format. You can see the model\ncard JSON schema in the `schema` directory.\n\n## References\n\n[1] https://arxiv.org/abs/1810.03993\n\n\n[ci_badge]: https://github.com/tensorflow/model-card-toolkit/actions/workflows/ci.yml/badge.svg\n[ci_link]: https://github.com/tensorflow/model-card-toolkit/actions/workflows/ci.yml\n\n[pypi_badge]: https://badge.fury.io/py/model-card-toolkit.svg\n[pypi_link]: https://badge.fury.io/py/model-card-toolkit\n\n[docs_badge]: https://img.shields.io/badge/TensorFow-page-orange\n[docs_link]: https://www.tensorflow.org/responsible_ai/model_card_toolkit/guide\n","funding_links":[],"categories":["Further reading list","模型的可解释性","Metadata Management","AI Safety Tools","Awesome Privacy Engineering [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)","Technical Resources","LLM SECURITY / AI SECURITY","Python","Tooling"],"sub_categories":["Open Source Tools","Machine Learning and Algorithmic Bias","Open Source/Access Responsible AI Software Packages","AI/ML Dataset Security"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftensorflow%2Fmodel-card-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftensorflow%2Fmodel-card-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftensorflow%2Fmodel-card-toolkit/lists"}