2024-01-31 11:18:49 +01:00
---
title: Introduction
2024-04-24 22:22:50 +02:00
description: 'Welcome to Upscayl Documentation! 🎉'
2024-01-31 11:18:49 +01:00
---
2024-04-24 22:22:50 +02:00
Here we're trying to build documentation around Upscayl for everyone.
2024-01-31 11:18:49 +01:00
2024-04-24 22:22:50 +02:00
This guide will continue to grow as we add more content. If you have any suggestions, please feel free to let us know on [GitHub Issues](https://github.com/upscayl/upscayl/issues) 🙏🏻
2024-01-31 11:18:49 +01:00
2024-04-24 22:22:50 +02:00
### Contents
2024-01-31 11:18:49 +01:00
<CardGroup cols={2}>
2024-04-24 22:22:50 +02:00
<Card
title="🙋 How to ask for help?"
href="https://github.com/upscayl/upscayl/wiki/%F0%9F%99%8B-How-to-ask-for-help%3F"
2024-01-31 11:18:49 +01:00
>
2024-04-24 22:22:50 +02:00
Read this guide to learn how to ask for help on Upscayl's GitHub.
2024-01-31 11:18:49 +01:00
</Card>
2024-04-24 22:22:50 +02:00
<Card
title="🧩 Compatibility List"
href="https://github.com/upscayl/upscayl/wiki/Compatibility-List"
2024-01-31 11:18:49 +01:00
>
2024-04-24 22:22:50 +02:00
Check if your GPU is compatible with Upscayl.
2024-01-31 11:18:49 +01:00
</Card>
2024-04-24 22:22:50 +02:00
<Card
title="📖 User Guide"
href="https://github.com/upscayl/upscayl/wiki/Guide"
>
Learn the various confusing features of Upscayl.
</Card>
<Card
title="🔨 Troubleshooting"
href="https://github.com/upscayl/upscayl/wiki/Troubleshooting"
2024-01-31 11:18:49 +01:00
>
2024-04-24 22:22:50 +02:00
Learn how to troubleshoot common issues with Upscayl.
2024-01-31 11:18:49 +01:00
</Card>
2024-04-24 22:22:50 +02:00
<Card
title="🖥️ Model Conversion Guide"
href="https://github.com/upscayl/upscayl/wiki/Model-Conversion-Guide"
2024-01-31 11:18:49 +01:00
>
2024-04-24 22:22:50 +02:00
Learn how to convert PyTorch models to NCNN models for Upscayl.
2024-01-31 11:18:49 +01:00
</Card>
2024-04-24 22:22:50 +02:00
<Card
title="🤫 Miscellaneous Configuration"
href="https://github.com/upscayl/upscayl/wiki/Misc"
2024-01-31 11:18:49 +01:00
>
2024-04-24 22:22:50 +02:00
Learn about the miscellaneous configurations in Upscayl.
2024-01-31 11:18:49 +01:00
</Card>
2024-04-24 22:22:50 +02:00
<Card
title="🤯 Using Upscayl on Windows and Linux with only a CPU"
href="https://github.com/upscayl/upscayl/issues/390"
2024-01-31 11:18:49 +01:00
>
2024-04-24 22:22:50 +02:00
Learn how to use Upscayl on Windows and Linux without a graphics card.
2024-01-31 11:18:49 +01:00
</Card>
</CardGroup>
2024-04-24 22:22:50 +02:00