This project has been archived by its maintainers, and is no longer receiving any updates.
ccrestoration
an inference lib for image/video restoration with VapourSynth support, compatible with many community models
Install
Make sure you have Python >= 3.9 and PyTorch >= 1.13 installed
pip install ccrestoration
- Install VapourSynth (optional)
Start
cv2
a simple example to use the SISR (Single Image Super-Resolution) model to process an image (APISR)
import cv2
import numpy as np
from ccrestoration import AutoModel, ConfigType, SRBaseModel
model: SRBaseModel = AutoModel.from_pretrained(
pretrained_model_name=ConfigType.RealESRGAN_APISR_RRDB_GAN_generator_2x,
)
img = cv2.imdecode(np.fromfile("test.jpg", dtype=np.uint8), cv2.IMREAD_COLOR)
img = model.inference_image(img)
cv2.imwrite("test_out.jpg", img)
VapourSynth
a simple example to use the VSR (Video Super-Resolution) model to process a video (AnimeSR)
import vapoursynth as vs
from vapoursynth import core
from ccrestoration import AutoModel, BaseModelInterface, ConfigType
model: BaseModelInterface = AutoModel.from_pretrained(
pretrained_model_name=ConfigType.RealESRGAN_AnimeJaNai_HD_V3_Compact_2x,
tile=None
)
clip = core.bs.VideoSource(source="s.mp4")
clip = core.resize.Bicubic(clip=clip, matrix_in_s="709", format=vs.RGBH)
clip = model.inference_video(clip)
clip = core.resize.Bicubic(clip=clip, matrix_s="709", format=vs.YUV420P16)
clip.set_output()
See more examples in the example directory, ccrestoration can register custom configurations and models to extend the functionality
Current Support
It still in development, the following models are supported:
Notice
-
All the architectures have been edited to normalize input and output, and automatic padding is applied. The input and output tensor shapes may differ from the original architectures. For SR models, the input and output are both 4D tensors in the shape of
(b, c, h, w). For VSR models, the input and output are both 5D tensors in the shape of(b, l, c, h, w). -
For VSR models with equal l in input and output
(f1, f2, f3, f4 -> f1', f2', f3', f4'), you can directly extend fromclass VSRBaseModel. For VSR models that output only one frame(f-2, f-1, f0, f1, f2 -> f0'), you also need to setself.one_frame_out = True.
Reference
License
This project is licensed under the MIT - see the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for ccrestoration 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ccrestoration-0.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Release files / ccrestoration-0.2.2-py3-none-any.whl
| Download URL | ccrestoration-0.2.2-py3-none-any.whl |
|---|---|
| Size | 97.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7cf089080f732d0ede368c4c6e49b235040a92590e55b32a14ddd69071be260b
|
|
BLAKE2b-256 checksum How to use checksums |
3b4f6772f4c54a2517e503b090a87a50cf0e86354f5b4f13b1f4f9e42228186a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for ccrestoration 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
