Cool_Tools/upscayl
1
0
Fork 0
mirror of https://github.com/upscayl/upscayl.git synced 2024-11-23 23:21:05 +01:00
Code Releases Wiki Activity

docs: fix typos (#1014)

Browse Source 
* Update Guide.md
* Update How-to-ask-for-help.md
* Update quickstart.mdx
This commit is contained in:
VaibhavWakde52 2024-10-31 02:12:13 +05:30 committed by GitHub
parent fbe3143ff6
commit cf912481b2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Guide.md
View File

@ -23,7 +23,7 @@ or even `0,1,2`
The logs appear in the Settings tab.
<img src="https://github.com/upscayl/upscayl/assets/25067102/ae8975b9-39d3-43a7-8ab5-435b42a67e6e" height="500px" />
To copy a log, you can press the COPY button and to paste it in the GitHub issue template for bug reports.
To copy a log, you can press the COPY button and paste it in the GitHub issue template for bug reports.
## Custom Models
Since Upscayl v2.5, you can load your own NCNN models into Upscayl. To convert models from PyTorch, see [🖥️ Model Conversion Guide](../%F0%9F%96%A5%EF%B8%8F-Model-Conversion-%E2%80%90-Create-more-AI-models!). You could also load Upscayl's official [Custom Models Repository](https://github.com/upscayl/custom-models).
@ -39,4 +39,4 @@ To use your custom models, follow these steps:
## Scale Option
Since v2.8, Upscayl emulates the scale option by Downscayling the x4 image for unsupported models.
Not all models support x1, x2 and x3; all the default models only support x4. To use other scales as native model output, you can get the compatible models from the [Custom Models Repository](https://github.com/upscayl/custom-models). For example, with the `realesr-animevideov3-x2` model, you can use the scale x2; with `realesr-animevideov3-x3`, you can use the scale x3.
Not all models support x1, x2 and x3; all the default models only support x4. To use other scales as native model output, you can get the compatible models from the [Custom Models Repository](https://github.com/upscayl/custom-models). For example, with the `realesr-animevideov3-x2` model, you can use the scale x2; with `realesr-animevideov3-x3`, you can use the scale x3.

4
docs/How-to-ask-for-help.md
View File

@ -9,7 +9,7 @@
GitHub is a powerful platform that fosters collaboration and open-source development. If you're new to GitHub and need assistance with Upscayl, follow these steps to effectively ask for help:
### 1. Search for Similar Issues
Before posting a new issue, [search the repository's issue tracker](https://github.com/upscayl/upscayl/issues) to check if someone else has encountered a similar problem. Also [check the discussions tab](https://github.com/upscayl/upscayl/discussions) for any pre-existing discussions. This helps to avoid duplicate issues and ensures that you're not asking a question that has already been answered. You should also chech the [FAQ](https://github.com/upscayl/upscayl/tree/main#-faq).
Before posting a new issue, [search the repository's issue tracker](https://github.com/upscayl/upscayl/issues) to check if someone else has encountered a similar problem. Also [check the discussions tab](https://github.com/upscayl/upscayl/discussions) for any pre-existing discussions. This helps to avoid duplicate issues and ensures that you're not asking a question that has already been answered. You should also check the [FAQ](https://github.com/upscayl/upscayl/tree/main#-faq).
### 2. Provide Logs and Context
- To create a new issue, go to the [Issues tab](https://github.com/upscayl/upscayl/issues) and click **'New Issue'**.
@ -19,4 +19,4 @@ Make sure to provide detailed context about the problem you're facing. Include r
If you don't know how to copy/see the logs, [follow this link](https://github.com/upscayl/upscayl/wiki/Guide#logs).
### 3. Be Clear and Specific
Clearly articulate your issue or question in a concise manner. The title should clearly mention the problem. Avoid ambiguous language and provide specific details about what you're trying to achieve. This will make it easier for others to understand your problem and offer a targeted solution. Our default issue template provides a suggested, organized way to do this.
Clearly articulate your issue or question in a concise manner. The title should clearly mention the problem. Avoid ambiguous language and provide specific details about what you're trying to achieve. This will make it easier for others to understand your problem and offer a targeted solution. Our default issue template provides a suggested, organized way to do this.

2
docs/quickstart.mdx
View File

@ -5,7 +5,7 @@ description: 'Start building awesome documentation in under 5 minutes'
## Setup your development
Learn how to update your docs locally and and deploy them to the public.
Learn how to update your docs locally and deploy them to the public.
### Edit and preview