describe package

Submodules

describe.describer_v2 module

class describe.describer_v2.Describer(api_key, api_base_url, model_name, org_id, prompt_templates, **model_kwargs)

Bases: VisionLanguageModel

decompose_design(design_goal: DesignGoal) → Tuple[Dict[str, Any], str]

Decompose the design into its constituent parts, specifying building methods and geometric details. Returns a tuple of (parsed JSON result, raw response).

design_feedback_loop(design: DesignGoal, iteration: int = 1, max_iterations: int = 5, feedback: str = None) → DesignGoal

Execute the complete design feedback cycle using recursion.

featurize_design_goal_with_confidence(design_goal: DesignGoal, user_feedback: str = None) → Tuple[Dict[str, Any], str]

Generate a refined design based on the user’s goal. Returns a tuple of (parsed JSON result, raw response).

describe.utils module

describe.utils.get_images_from_folder(folder_path: str) → List[str]

Get all image files from the specified folder.

describe.utils.load_object_metadata(task_path: str) → List[dict]

describe.utils.save_descriptions(base_dirs: str | List[str], descriptions: dict | List[dict])

Module contents