qilisdk.utils.visualization.style

Classes

Style	!!! abstract "Usage Documentation"
QTensorStyle	All visual parameters controlling the appearance of a QTensor plot.
CircuitStyle	All visual parameters controlling the appearance of a circuit plot.
ScheduleStyle	Customization options for matplotlib schedule plots, with theme support.

Module Contents

class Style(/, **data: Any)

Bases: pydantic.BaseModel

!!! abstract «Usage Documentation»

[Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__

The names of the class variables defined on the model.

__private_attributes__

Metadata about the private attributes of the model.

__signature__

The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__

Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__

The core schema of the model.

__pydantic_custom_init__

Whether the model has a custom __init__ function.

__pydantic_decorators__

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__

A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

__pydantic_parent_namespace__

Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__

The name of the post-init method for the model, if defined.

__pydantic_root_model__

Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__

The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__

The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__

A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__

A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__

A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to “allow”.

__pydantic_fields_set__

The names of fields explicitly set during instantiation.

__pydantic_private__

Values of private attributes set on the model instance.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

theme: qilisdk.utils.visualization.themes.Theme = None

fontfamily: str | list[str] | None = None

fontstyle: Literal['normal', 'italic', 'oblique'] = None

fontvariant: Literal['normal', 'small-caps'] = None

fontweight: str | int = None

fontstretch: str | int = None

fontsize: float | str = None

fontfname: str | None = None

math_fontfamily: str | None = None

dpi: int = None

title: str | None = None

property font: matplotlib.font_manager.FontProperties

Construct a Matplotlib FontProperties from the configured fields. If fontfname points to a real file, it is used (and overrides family).

class QTensorStyle(/, **data: Any)

Bases: Style

All visual parameters controlling the appearance of a QTensor plot.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

sphere_points: int = None

sphere_color: str = None

arrow_color: str = None

arrow_length_ratio: float = None

draw_center_circle: bool = None

centre_circle_color: str = None

draw_reference_points: bool = None

reference_point_distance: float = None

rotation_style: Literal['azel', 'trackball', 'sphere', 'arcball'] = None

class CircuitStyle(/, **data: Any)

Bases: Style

All visual parameters controlling the appearance of a circuit plot.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

end_wire_ext: int = None

padding: float = None

gate_margin: float = None

wire_sep: float = None

layer_sep: float = None

gate_pad: float = None

label_pad: float = None

bulge: str = None

align_layer: bool = None

wire_label: list[Any] | None = None

start_pad: float = None

min_gate_h: float = None

min_gate_w: float = None

connector_r: float = None

target_r: float = None

control_r: float = None

layout: Literal['normal', 'compact'] = None

class ScheduleStyle(/, **data: Any)

Bases: Style

Customization options for matplotlib schedule plots, with theme support.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

figsize: tuple | None = None

grid: bool = None

grid_style: dict[str, Any] = None

title_fontsize: int = None

xlabel: str = None

ylabel: str = None

label_fontsize: int = None

legend_loc: str = None

legend_fontsize: int = None

legend_frame: bool = None

line_styles: dict[str, dict[str, Any]] = None

default_line_style: dict[str, Any] = None

marker: str | None = None

marker_size: int = None

xtick_fontsize: int = None

ytick_fontsize: int = None

tick_color: str | None = None

tight_layout: bool = None