sketchkit.stylization package

Subpackages

• sketchkit.stylization.brushstrokesengine package
  • Subpackages
    • sketchkit.stylization.brushstrokesengine.forger package
      • Subpackages
      • Module contents
    • sketchkit.stylization.brushstrokesengine.thirdparty package
      • Subpackages
      • Module contents
  • Submodules
  • sketchkit.stylization.brushstrokesengine.brushstroke_stylizer module
    • BrushstrokeStylizer
      • BrushstrokeStylizer.model_name
      • BrushstrokeStylizer.style_id
      • BrushstrokeStylizer.models_dir
      • BrushstrokeStylizer.device
      • BrushstrokeStylizer._get_option()
      • BrushstrokeStylizer._import_forger()
      • BrushstrokeStylizer._render_sketch_to_png()
      • BrushstrokeStylizer._run_forger_stylization()
      • BrushstrokeStylizer.run()
      • BrushstrokeStylizer.run_from_png()
  • sketchkit.stylization.brushstrokesengine.models module
    • check_models_available()
    • download_models()
    • get_model_path()
    • get_models_dir()
  • Module contents
    • BrushstrokeStylizer
      • BrushstrokeStylizer.model_name
      • BrushstrokeStylizer.style_id
      • BrushstrokeStylizer.models_dir
      • BrushstrokeStylizer.device
      • BrushstrokeStylizer._get_option()
      • BrushstrokeStylizer._import_forger()
      • BrushstrokeStylizer._render_sketch_to_png()
      • BrushstrokeStylizer._run_forger_stylization()
      • BrushstrokeStylizer.run()
      • BrushstrokeStylizer.run_from_png()

Submodules

sketchkit.stylization.stylizer module

Stylizer - Unified Interface for Sketch Stylization

This module provides a unified API for stylizing sketches using various methods.

class sketchkit.stylization.stylizer.Stylizer(method: str = 'brushstrokesengine', **kwargs: Any)

Bases: object

A unified wrapper class for stylizing sketches using various methods.

This class provides a consistent API across different stylization methods, allowing users to switch between methods easily.

method

The stylization method being used.

Type:

str

_stylizer

The underlying method-specific stylizer instance.

property model_name: str | None

Get the model name (if supported by the method).

run(sketch: Sketch, output_path: str | None = None, **kwargs: Any) → Image

Stylize a sketch using the selected method.

Parameters:

• sketch – Input vector sketch.

• output_path – Output file path. If None, uses a temporary path.

• **kwargs – Method-specific parameters (passed to the underlying method).

Returns:

Stylized image as PIL Image.

Example

>>> stylizer = Stylizer(method="brushstrokesengine")
>>> stylized_image = stylizer.run(sketch, output_path="output.png")

run_from_png(png_path: str | Path, output_path: str | None = None, **kwargs: Any) → Image

Stylize an existing PNG image using the selected method.

Parameters:

• png_path – Path to the input PNG geometry image.

• output_path – Output file path. If None, uses a temporary path.

• **kwargs – Method-specific parameters (passed to the underlying method).

Returns:

Stylized image as PIL Image.

Example

>>> stylizer = Stylizer(method="brushstrokesengine")
>>> stylized_image = stylizer.run_from_png("input.png", output_path="output.png")

property style_id: str | None

Get the style ID (if supported by the method).

Module contents

Sketch Stylization Module

This module provides a unified API for stylizing sketches using various methods.

class sketchkit.stylization.Stylizer(method: str = 'brushstrokesengine', **kwargs: Any)

Bases: object

A unified wrapper class for stylizing sketches using various methods.

This class provides a consistent API across different stylization methods, allowing users to switch between methods easily.

method

The stylization method being used.

Type:

str

_stylizer

The underlying method-specific stylizer instance.

property model_name: str | None

Get the model name (if supported by the method).

run(sketch: Sketch, output_path: str | None = None, **kwargs: Any) → Image

Stylize a sketch using the selected method.

Parameters:

• sketch – Input vector sketch.

• output_path – Output file path. If None, uses a temporary path.

• **kwargs – Method-specific parameters (passed to the underlying method).

Returns:

Stylized image as PIL Image.

Example

>>> stylizer = Stylizer(method="brushstrokesengine")
>>> stylized_image = stylizer.run(sketch, output_path="output.png")

run_from_png(png_path: str | Path, output_path: str | None = None, **kwargs: Any) → Image

Stylize an existing PNG image using the selected method.

Parameters:

• png_path – Path to the input PNG geometry image.

• output_path – Output file path. If None, uses a temporary path.

• **kwargs – Method-specific parameters (passed to the underlying method).

Returns:

Stylized image as PIL Image.

Example

>>> stylizer = Stylizer(method="brushstrokesengine")
>>> stylized_image = stylizer.run_from_png("input.png", output_path="output.png")

property style_id: str | None

Get the style ID (if supported by the method).