onnx ¶
This module implements scalers for ONNX models.
Classes:
-
ArtCNN
–Super-Resolution Convolutional Neural Networks optimised for anime.
-
BaseOnnxScaler
–Abstract generic scaler class for an ONNX model.
-
DPIR
–Deep Plug-and-Play Image Restoration
-
GenericOnnxScaler
–Generic scaler class for an ONNX model.
-
Waifu2x
–Well known Image Super-Resolution for Anime-Style Art.
Functions:
-
autoselect_backend
–Try to select the best backend for the current system.
ArtCNN ¶
ArtCNN(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
Super-Resolution Convolutional Neural Networks optimised for anime.
A quick reminder that vs-mlrt does not ship these in the base package.
You will have to grab the extended models pack or get it from the repo itself.
(And create an "ArtCNN" folder in your models folder yourself)
https://github.com/Artoriuz/ArtCNN/releases/latest
Defaults to R8F64.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
C16F64
–Very fast and good enough for AA purposes but the onnx variant is officially deprecated.
-
C16F64_Chroma
–The bigger of the two chroma models.
-
C16F64_DS
–The same as C16F64 but intended to also sharpen and denoise.
-
C4F16
–This has 4 internal convolution layers with 16 filters each.
-
C4F16_DS
–The same as C4F16 but intended to also sharpen and denoise.
-
C4F32
–This has 4 internal convolution layers with 32 filters each.
-
C4F32_Chroma
–The smaller of the two chroma models.
-
C4F32_DS
–The same as C4F32 but intended to also sharpen and denoise.
-
R16F96
–The biggest model. Can compete with or outperform Waifu2x Cunet.
-
R8F64
–A smaller and faster version of R16F96 but very competitive.
-
R8F64_Chroma
–The new and fancy big chroma model.
-
R8F64_DS
–The same as R8F64 but intended to also sharpen and denoise.
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
C16F64 ¶
C16F64(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
Very fast and good enough for AA purposes but the onnx variant is officially deprecated.
This has 16 internal convolution layers with 64 filters each.
ONNX files available at https://github.com/Artoriuz/ArtCNN/tree/388b91797ff2e675fd03065953cc1147d6f972c2/ONNX
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.C16F64().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C16F64_Chroma ¶
C16F64_Chroma(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNChroma
The bigger of the two chroma models.
These don't double the input clip and rather just try to enhance the chroma using luma information.
Example usage:
from vsscale import ArtCNN
chroma_upscaled = ArtCNN.C16F64_Chroma().scale(clip)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C16F64_DS ¶
C16F64_DS(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
The same as C16F64 but intended to also sharpen and denoise.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.C16F64_DS().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C4F16 ¶
C4F16(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
This has 4 internal convolution layers with 16 filters each.
The currently fastest variant. Not really recommended for any filtering.
Should strictly be used for real-time applications and even then the other non R ones should be fast enough...
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.C4F16().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C4F16_DS ¶
C4F16_DS(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
The same as C4F16 but intended to also sharpen and denoise.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.C4F16_DS().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C4F32 ¶
C4F32(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
This has 4 internal convolution layers with 32 filters each.
If you need an even faster model.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.C4F32().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C4F32_Chroma ¶
C4F32_Chroma(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNChroma
The smaller of the two chroma models.
These don't double the input clip and rather just try to enhance the chroma using luma information.
Example usage:
from vsscale import ArtCNN
chroma_upscaled = ArtCNN.C4F32_Chroma().scale(clip)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
C4F32_DS ¶
C4F32_DS(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
The same as C4F32 but intended to also sharpen and denoise.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.C4F32_DS().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
R16F96 ¶
R16F96(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
The biggest model. Can compete with or outperform Waifu2x Cunet.
Also quite a bit slower but is less heavy on vram.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.R16F96().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
R8F64 ¶
R8F64(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
A smaller and faster version of R16F96 but very competitive.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.R8F64().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
R8F64_Chroma ¶
R8F64_Chroma(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNChroma
The new and fancy big chroma model.
These don't double the input clip and rather just try to enhance the chroma using luma information.
Example usage:
from vsscale import ArtCNN
chroma_upscaled = ArtCNN.R8F64_Chroma().scale(clip)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
R8F64_DS ¶
R8F64_DS(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNNLuma
The same as R8F64 but intended to also sharpen and denoise.
Example usage:
from vsscale import ArtCNN
doubled = ArtCNN.R8F64_DS().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseArtCNN ¶
BaseArtCNN(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseOnnxScaler
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
–Performs preprocessing on the clip prior to inference.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Performs preprocessing on the clip prior to inference.
Source code
255 256 257 258 259 260 261 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseArtCNNChroma ¶
BaseArtCNNChroma(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNN
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseArtCNNLuma ¶
BaseArtCNNLuma(
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseArtCNN
Initializes the scaler with the specified parameters.
Parameters:
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
356 357 358 359 360 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
364 365 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseDPIR ¶
BaseDPIR(
strength: SupportsFloat | VideoNode = 10,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseOnnxScaler
Initializes the scaler with the specified parameters.
Parameters:
-
strength
¶SupportsFloat | VideoNode
, default:10
) –Threshold (8-bit scale) strength for deblocking/denoising. If a VideoNode is used, it must be in GRAY8, GRAYH, or GRAYS format, with pixel values representing the 8-bit thresholds.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
– -
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
– -
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
multiple
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
strength
– -
tiles
– -
tilesize
–
Source code
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Source code
1028 1029 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1039 1040 1041 1042 1043 1044 1045 1046 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
1031 1032 1033 1034 1035 1036 1037 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Source code
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseOnnxScaler ¶
BaseOnnxScaler(
model: SPathLike | None = None,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseGenericScaler
, ABC
Abstract generic scaler class for an ONNX model.
Initializes the scaler with the specified parameters.
Parameters:
-
model
¶SPathLike | None
, default:None
) –Path to the ONNX model file.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
–Runs inference on the given video clip using the configured model and backend.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
–Performs preprocessing on the clip prior to inference.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Runs inference on the given video clip using the configured model and backend.
Source code
272 273 274 275 276 277 278 279 280 281 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Performs preprocessing on the clip prior to inference.
Source code
255 256 257 258 259 260 261 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseWaifu2x ¶
BaseWaifu2x(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseOnnxScaler
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
–Performs preprocessing on the clip prior to inference.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Performs preprocessing on the clip prior to inference.
Source code
255 256 257 258 259 260 261 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BaseWaifu2xRGB ¶
BaseWaifu2xRGB(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2x
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
DPIR ¶
DPIR(
strength: SupportsFloat | VideoNode = 10,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseDPIR
Deep Plug-and-Play Image Restoration
Initializes the scaler with the specified parameters.
Parameters:
-
strength
¶SupportsFloat | VideoNode
, default:10
) –Threshold (8-bit scale) strength for deblocking/denoising. If a VideoNode is used, it must be in GRAY8, GRAYH, or GRAYS format, with pixel values representing the 8-bit thresholds.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
DrunetDeblock
–DPIR model for deblocking.
-
DrunetDenoise
–DPIR model for denoising.
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
– -
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
– -
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
multiple
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
strength
– -
tiles
– -
tilesize
–
Source code
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
DrunetDeblock ¶
DrunetDeblock(
strength: SupportsFloat | VideoNode = 10,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseDPIR
DPIR model for deblocking.
Initializes the scaler with the specified parameters.
Parameters:
-
strength
¶SupportsFloat | VideoNode
, default:10
) –Threshold (8-bit scale) strength for deblocking/denoising. If a VideoNode is used, it must be in GRAY8, GRAYH, or GRAYS format, with pixel values representing the 8-bit thresholds.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
– -
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
– -
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
multiple
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
strength
– -
tiles
– -
tilesize
–
Source code
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Source code
1028 1029 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1039 1040 1041 1042 1043 1044 1045 1046 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
1031 1032 1033 1034 1035 1036 1037 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Source code
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
DrunetDenoise ¶
DrunetDenoise(
strength: SupportsFloat | VideoNode = 10,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseDPIR
DPIR model for denoising.
Initializes the scaler with the specified parameters.
Parameters:
-
strength
¶SupportsFloat | VideoNode
, default:10
) –Threshold (8-bit scale) strength for deblocking/denoising. If a VideoNode is used, it must be in GRAY8, GRAYH, or GRAYS format, with pixel values representing the 8-bit thresholds.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
– -
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
– -
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
multiple
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
strength
– -
tiles
– -
tilesize
–
Source code
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Source code
1028 1029 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1039 1040 1041 1042 1043 1044 1045 1046 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
1031 1032 1033 1034 1035 1036 1037 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Source code
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Source code
1028 1029 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
1039 1040 1041 1042 1043 1044 1045 1046 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
1031 1032 1033 1034 1035 1036 1037 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Source code
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
GenericOnnxScaler ¶
GenericOnnxScaler(
model: SPathLike | None = None,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseOnnxScaler
Generic scaler class for an ONNX model.
Example usage:
from vsscale import GenericOnnxScaler
scaled = GenericOnnxScaler("path/to/model.onnx").scale(clip, ...)
# For Windows paths:
scaled = GenericOnnxScaler(r"path\to\model.onnx").scale(clip, ...)
Initializes the scaler with the specified parameters.
Parameters:
-
model
¶SPathLike | None
, default:None
) –Path to the ONNX model file.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
–Runs inference on the given video clip using the configured model and backend.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
–Performs preprocessing on the clip prior to inference.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Runs inference on the given video clip using the configured model and backend.
Source code
272 273 274 275 276 277 278 279 280 281 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Performs preprocessing on the clip prior to inference.
Source code
255 256 257 258 259 260 261 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
Waifu2x ¶
Waifu2x(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: _Waifu2xCunet
Well known Image Super-Resolution for Anime-Style Art.
Defaults to Cunet.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
AnimeStyleArt
–Waifu2x model for anime-style art.
-
AnimeStyleArtRGB
–RGB version of the anime-style model.
-
Cunet
–CUNet (Compact U-Net) model for anime art.
-
Photo
–Waifu2x model trained on real-world photographic images.
-
SwinUnetArt
–Swin-Unet-based model trained on anime-style images.
-
SwinUnetArtScan
–Swin-Unet model trained on anime scans.
-
SwinUnetPhoto
–Swin-Unet model trained on photographic content.
-
SwinUnetPhotoV2
–Improved Swin-Unet model for photos (v2).
-
UpConv7AnimeStyleArt
–UpConv7 model variant optimized for anime-style images.
-
UpConv7Photo
–UpConv7 model variant optimized for photographic images.
-
UpResNet10
–UpResNet10 model offering a balance of speed and quality.
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
AnimeStyleArt ¶
AnimeStyleArt(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2x
Waifu2x model for anime-style art.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.AnimeStyleArt().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
–Handles postprocessing of the model's output after inference.
-
preprocess_clip
–Performs preprocessing on the clip prior to inference.
-
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Handles postprocessing of the model's output after inference.
Source code
263 264 265 266 267 268 269 270 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Performs preprocessing on the clip prior to inference.
Source code
255 256 257 258 259 260 261 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
AnimeStyleArtRGB ¶
AnimeStyleArtRGB(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
RGB version of the anime-style model.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.AnimeStyleArtRGB().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
Cunet ¶
Cunet(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: _Waifu2xCunet
CUNet (Compact U-Net) model for anime art.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.Cunet().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
767 768 769 770 771 772 773 774 775 776 777 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
779 780 781 782 783 784 785 786 787 788 789 790 791 792 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.Additional Notes for the Cunet model:
- The model can cause artifacts around the image edges. To mitigate this, mirrored padding is applied to the image before inference. This behavior can be disabled by setting
inference_no_pad=True
. - A tint issue is also present but it is not constant. It leaves flat areas alone but tints detailed areas. Since most people will use Cunet to rescale details, the tint fix is enabled by default. This behavior can be disabled with
postprocess_no_tint_fix=True
- The model can cause artifacts around the image edges. To mitigate this, mirrored padding is applied to the image before inference. This behavior can be disabled by setting
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
Photo ¶
Photo(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
Waifu2x model trained on real-world photographic images.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.Photo().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
SwinUnetArt ¶
SwinUnetArt(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
Swin-Unet-based model trained on anime-style images.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.SwinUnetArt().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
SwinUnetArtScan ¶
SwinUnetArtScan(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
Swin-Unet model trained on anime scans.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.SwinUnetArtScan().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
SwinUnetPhoto ¶
SwinUnetPhoto(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
Swin-Unet model trained on photographic content.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.SwinUnetPhoto().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
SwinUnetPhotoV2 ¶
SwinUnetPhotoV2(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
Improved Swin-Unet model for photos (v2).
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.SwinUnetPhotoV2().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
UpConv7AnimeStyleArt ¶
UpConv7AnimeStyleArt(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
UpConv7 model variant optimized for anime-style images.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.UpConv7AnimeStyleArt().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
UpConv7Photo ¶
UpConv7Photo(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
UpConv7 model variant optimized for photographic images.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.UpConv7Photo().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
UpResNet10 ¶
UpResNet10(
scale: Literal[1, 2, 4] = 2,
noise: Literal[-1, 0, 1, 2, 3] = -1,
backend: backendT | None = None,
tiles: int | tuple[int, int] | None = None,
tilesize: int | tuple[int, int] | None = None,
overlap: int | tuple[int, int] | None = None,
max_instances: int = 2,
*,
kernel: KernelLike = Catrom,
scaler: ScalerLike | None = None,
shifter: KernelLike | None = None,
**kwargs: Any
)
Bases: BaseWaifu2xRGB
UpResNet10 model offering a balance of speed and quality.
Example usage:
from vsscale import Waifu2x
doubled = Waifu2x.UpResNet10().scale(clip, clip.width * 2, clip.height * 2)
Initializes the scaler with the specified parameters.
Parameters:
-
scale
¶Literal[1, 2, 4]
, default:2
) –Upscaling factor. 1 = no uspcaling, 2 = 2x, 4 = 4x.
-
noise
¶Literal[-1, 0, 1, 2, 3]
, default:-1
) –Noise reduction level. -1 = none, 0 = low, 1 = medium, 2 = high, 3 = highest.
-
backend
¶backendT | None
, default:None
) –The backend to be used with the vs-mlrt framework. If set to None, the most suitable backend will be automatically selected, prioritizing fp16 support.
-
tiles
¶int | tuple[int, int] | None
, default:None
) –Whether to split the image into multiple tiles. This can help reduce VRAM usage, but note that the model's behavior may vary when they are used.
-
tilesize
¶int | tuple[int, int] | None
, default:None
) –The size of each tile when splitting the image (if tiles are enabled).
-
overlap
¶int | tuple[int, int] | None
, default:None
) –The size of overlap between tiles.
-
max_instances
¶int
, default:2
) –Maximum instances to spawn when scaling a variable resolution clip.
-
kernel
¶KernelLike
, default:Catrom
) –Base kernel to be used for certain scaling/shifting/resampling operations. Defaults to Catrom.
-
scaler
¶ScalerLike | None
, default:None
) –Scaler used for scaling operations. Defaults to kernel.
-
shifter
¶KernelLike | None
, default:None
) –Kernel used for shifting operations. Defaults to kernel.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to pass to the backend. See the vsmlrt backend's docstring for more details.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
calc_tilesize
–Reimplementation of vsmlrt.calc_tilesize helper function
-
ensure_obj
–Ensure that the input is a scaler instance, resolving it if necessary.
-
from_param
–Resolve and return a scaler type from a given input (string, type, or instance).
-
get_scale_args
–Generate the keyword arguments used for scaling.
-
inference
– -
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
postprocess_clip
– -
preprocess_clip
– -
pretty_string
–Cached property returning a user-friendly string representation.
-
scale
–Scale the given clip using the ONNX model.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
backend
– -
kernel
– -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
max_instances
– -
model
– -
noise
(Literal[-1, 0, 1, 2, 3]
) – -
overlap
– -
overlap_h
– -
overlap_w
– -
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
-
scale_w2x
(Literal[1, 2, 4]
) – -
scaler
– -
shifter
– -
tiles
– -
tilesize
–
Source code
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
716 717 718 719 720 721 722 723 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
291 |
|
calc_tilesize ¶
Reimplementation of vsmlrt.calc_tilesize helper function
Source code
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
ensure_obj classmethod
¶
ensure_obj(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> Self
Ensure that the input is a scaler instance, resolving it if necessary.
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–Scaler instance.
Source code
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
from_param classmethod
¶
from_param(
scaler: str | type[Self] | Self | None = None,
/,
func_except: FuncExceptT | None = None,
) -> type[Self]
Resolve and return a scaler type from a given input (string, type, or instance).
Parameters:
-
scaler
¶str | type[Self] | Self | None
, default:None
) –Scaler identifier (string, class, or instance).
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–Resolved scaler type.
Source code
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for scaling.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
**kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
inference ¶
inference(
clip: ConstantFormatVideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
767 768 769 770 771 772 773 774 775 776 777 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Returns:
-
int
–Kernel radius.
Source code
392 393 394 395 396 397 398 399 400 401 402 403 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
postprocess_clip ¶
postprocess_clip(
clip: VideoNode, input_clip: VideoNode, **kwargs: Any
) -> ConstantFormatVideoNode
Source code
779 780 781 782 783 784 785 786 787 788 789 790 791 792 |
|
preprocess_clip ¶
preprocess_clip(clip: VideoNode, **kwargs: Any) -> ConstantFormatVideoNode
Source code
712 713 714 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
419 420 421 422 423 424 425 426 427 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[float, float] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Scale the given clip using the ONNX model.
Parameters:
-
clip
¶VideoNode
) –The input clip to be scaled.
-
width
¶int | None
, default:None
) –The target width for scaling. If None, the width of the input clip will be used.
-
height
¶int | None
, default:None
) –The target height for scaling. If None, the height of the input clip will be used.
-
shift
¶tuple[float, float]
, default:(0, 0)
) –A tuple representing the shift values for the x and y axes.
-
**kwargs
¶Any
, default:{}
) –Additional arguments to be passed to the
preprocess_clip
,postprocess_clip
,inference
, and_final_scale
methods. Use the prefixpreprocess_
orpostprocess_
to pass an argument to the respective method. Use the prefixinference_
to pass an argument to the inference method.Additional Notes for the Cunet model:
- The model can cause artifacts around the image edges. To mitigate this, mirrored padding is applied to the image before inference. This behavior can be disabled by setting
inference_no_pad=True
. - A tint issue is also present but it is not constant. It leaves flat areas alone but tints detailed areas. Since most people will use Cunet to rescale details, the tint fix is enabled by default. This behavior can be disabled with
postprocess_no_tint_fix=True
- The model can cause artifacts around the image edges. To mitigate this, mirrored padding is applied to the image before inference. This behavior can be disabled by setting
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
**kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
autoselect_backend ¶
Try to select the best backend for the current system. If the system has an NVIDIA GPU: TRT > CUDA (ORT) > Vulkan > OpenVINO GPU Else: DirectML (D3D12) > MIGraphX > Vulkan > CPU (ORT) > CPU OpenVINO
Parameters:
Returns:
-
backendT
–The selected backend.
Source code
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
|