# Final2x-core
[](https://codecov.io/gh/Tohrusky/Final2x-core)
[](https://github.com/Tohrusky/Final2x-core/actions/workflows/CI-test.yml)
[](https://github.com/Tohrusky/Final2x-core/actions/workflows/pip-test.yml)
[](https://github.com/Tohrusky/Final2x-core/actions/workflows/Release.yml)
[](https://badge.fury.io/py/Final2x-core)
Final2x-core is a cross-platform image super-resolution CLI tool for [Final2x](https://github.com/Tohrusky/Final2x). If you have any questions, please raise an issue [in this repository](https://github.com/Tohrusky/Final2x).
### Install
Download in [Release](https://github.com/Tohrusky/Final2x-core/releases) or use pip to install (Linux User).
Make sure you have Python >= 3.9 and PyTorch >= 1.13 installed
```shell
pip install Final2x-core
```
### cli
```shell
usage: Final2x-core [-h] [-b BASE64] [-j JSON] [-y YAML] [-l] [-n]
when para is not specified, the config.yaml file in the directory will be read automatically
options:
-h, --help show this help message and exit
-b BASE64, --BASE64 BASE64
base64 string for config json
-j JSON, --JSON JSON JSON string for config
-y YAML, --YAML YAML yaml config file path
-l, --LOG save log
-n, --NOTOPENFOLDER don't open output folder
```
### Config
Refer to config.yaml which generated by the following command:
```shell
make gen
```
### Reference
The following references were used in the development of this project:
After v3.0.0, ncnn will be deprecated, and the project will use ccrestoration(PyTorch) as the algorithm implementation.
- [ccrestoration](https://github.com/TensoRaws/ccrestoration)
- [PyTorch](https://github.com/pytorch/pytorch)
---
- [ncnn](https://github.com/Tencent/ncnn)
- [nihui/realcugan-ncnn-vulkan](https://github.com/nihui/realcugan-ncnn-vulkan)
- [xinntao/Real-ESRGAN-ncnn-vulkan](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan)
- [nihui/waifu2x-ncnn-vulkan](https://github.com/nihui/waifu2x-ncnn-vulkan)
- [realcugan-ncnn-py](https://github.com/Tohrusky/realcugan-ncnn-py)
- [realesrgan-ncnn-py](https://github.com/Tohrusky/realesrgan-ncnn-py)
- [waifu2x-ncnn-py](https://github.com/Tohrusky/waifu2x-ncnn-py)
### License
This project is licensed under the BSD 3-Clause - see
the [LICENSE file](https://github.com/Tohrusky/Final2x-core/blob/main/LICENSE) for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/Tohrusky/Final2x-core",
"name": "Final2x-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Tohrusky",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# Final2x-core\n\n\n\n\n\n\n\n[](https://codecov.io/gh/Tohrusky/Final2x-core)\n[](https://github.com/Tohrusky/Final2x-core/actions/workflows/CI-test.yml)\n[](https://github.com/Tohrusky/Final2x-core/actions/workflows/pip-test.yml)\n[](https://github.com/Tohrusky/Final2x-core/actions/workflows/Release.yml)\n[](https://badge.fury.io/py/Final2x-core)\n\n\nFinal2x-core is a cross-platform image super-resolution CLI tool for [Final2x](https://github.com/Tohrusky/Final2x). If you have any questions, please raise an issue [in this repository](https://github.com/Tohrusky/Final2x).\n\n### Install\n\nDownload in [Release](https://github.com/Tohrusky/Final2x-core/releases) or use pip to install (Linux User).\n\nMake sure you have Python >= 3.9 and PyTorch >= 1.13 installed\n\n```shell\npip install Final2x-core\n```\n\n### cli\n\n```shell\nusage: Final2x-core [-h] [-b BASE64] [-j JSON] [-y YAML] [-l] [-n]\n\nwhen para is not specified, the config.yaml file in the directory will be read automatically\n\noptions:\n -h, --help show this help message and exit\n -b BASE64, --BASE64 BASE64\n base64 string for config json\n -j JSON, --JSON JSON JSON string for config\n -y YAML, --YAML YAML yaml config file path\n -l, --LOG save log\n -n, --NOTOPENFOLDER don't open output folder\n```\n\n### Config\n\nRefer to config.yaml which generated by the following command:\n\n```shell\nmake gen\n```\n\n### Reference\n\nThe following references were used in the development of this project:\n\nAfter v3.0.0, ncnn will be deprecated, and the project will use ccrestoration(PyTorch) as the algorithm implementation.\n\n- [ccrestoration](https://github.com/TensoRaws/ccrestoration)\n- [PyTorch](https://github.com/pytorch/pytorch)\n\n---\n\n- [ncnn](https://github.com/Tencent/ncnn)\n- [nihui/realcugan-ncnn-vulkan](https://github.com/nihui/realcugan-ncnn-vulkan)\n- [xinntao/Real-ESRGAN-ncnn-vulkan](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan)\n- [nihui/waifu2x-ncnn-vulkan](https://github.com/nihui/waifu2x-ncnn-vulkan)\n- [realcugan-ncnn-py](https://github.com/Tohrusky/realcugan-ncnn-py)\n- [realesrgan-ncnn-py](https://github.com/Tohrusky/realesrgan-ncnn-py)\n- [waifu2x-ncnn-py](https://github.com/Tohrusky/waifu2x-ncnn-py)\n\n### License\n\nThis project is licensed under the BSD 3-Clause - see\nthe [LICENSE file](https://github.com/Tohrusky/Final2x-core/blob/main/LICENSE) for details.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "core library for Final2x",
"version": "3.1.0",
"project_urls": {
"Homepage": "https://github.com/Tohrusky/Final2x-core",
"Repository": "https://github.com/Tohrusky/Final2x-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80b9b9c89b1ada7d25b174030cc0bbf698680862b0056e3afd40bc63db47b4b4",
"md5": "9b3ca5b8ed95a53b1ac138c2875c41d4",
"sha256": "d38ecefbfcc70483437be88a5a955f4575520f46187bbbf6eba29532584ce8d0"
},
"downloads": -1,
"filename": "final2x_core-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b3ca5b8ed95a53b1ac138c2875c41d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 9427,
"upload_time": "2024-12-14T17:11:39",
"upload_time_iso_8601": "2024-12-14T17:11:39.387365Z",
"url": "https://files.pythonhosted.org/packages/80/b9/b9c89b1ada7d25b174030cc0bbf698680862b0056e3afd40bc63db47b4b4/final2x_core-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 17:11:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tohrusky",
"github_project": "Final2x-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "final2x-core"
}
JSON
