easydel.utils.readme_generator

easydel.utils.readme_generator#

class easydel.utils.readme_generator.ModelInfo(name: str, type: str, repo_id: str, description: str | None = None, model_type: str | None = None, model_task: str = 'CausalLM', attn_mechanism: str = 'vanilla', features: list[str] | None = None, supported_tasks: list[str] | None = None, limitations: list[str] | None = None, version: str = '0.1.5', overview: str | None = None)[source]#

Bases: object

Model information container. Used to pass data to the Jinja template.

attn_mechanism: str = 'vanilla'#
description: str | None = None#
features: list[str] | None = None#
limitations: list[str] | None = None#
model_task: str = 'CausalLM'#
model_type: str | None = None#
name: str#
overview: str | None = None#
repo_id: str#
supported_tasks: list[str] | None = None#
type: str#
version: str = '0.1.5'#
class easydel.utils.readme_generator.ReadmeGenerator(template_dir: str | None = None)[source]#

Bases: object

Generate README files for EasyDeL models.

generate_readme(model_info: ModelInfo, output_path: str | None = None) → str[source]#

Generate README content for a model.

Parameters

  • model_info – Model information

  • output_path – tp.Optional path to save the README

Returns

Generated README content

Contents