Welcome to waifuc’s Documentation

Overview

waifuc is a module which can parse and manage the configuration file’s structure and their versions.

Tutorials

• Installation
• Training a LoRA for My Waifu
  • What Should I Do?
  • How Does the Code Work?
  • Good News!
• Crawling Some Images From Websites
  • How to Crawl Data From Websites?
  • Crawling Data from Multiple Websites
  • Why Are There So Many JSON Files?
  • I Don’t Want to Save Images to Disk, How Can I Use Them Directly?
• Process Crawled or Local Images and Data
  • How to Process Data
  • Common Actions and Usage Examples
  • Other Actions
• Extracting Character Images from Videos
  • Install Additional Dependencies
  • Extract Images from Video Files
  • Extract Images from a Folder Containing Videos
  • Extract Character Images from a Folder Containing Videos
• How to Prevent Waifuc from Using GPU
  • Preventing GPU Usage in Waifuc
  • Minimum Hardware Requirements for Waifuc

中文教程

• 使用须知
  • 这是什么？
  • 怎么安装？
  • 能做什么？
  • 我该怎么使用？
  • 译者留言
• 我想给我老婆炼丹
  • 我该怎么做？
  • 上文提供的代码是如何运行的？
  • 好消息！
• 我想从网站上爬取一些数据
  • 如何从网站爬取数据？
  • 我想从多个网站上爬取数据
  • 为什么会有这么多json文件？
  • 我不想将图像保存到硬盘上，如何直接使用它们？
• 我想处理爬取到的或本地的图像
  • 如何对数据进行处理？
  • 常见的Action及使用示例
  • ModeConvertAction
  • FirstNSelectAction
  • NoMonochromeAction
  • ClassFilterAction
  • FilterSimilarAction
  • TaggingAction
  • PersonSplitAction
  • FaceCountAction
  • CCIPAction
  • AlignMinSizeAction
  • RandomFilenameAction
  • ThreeStageSplitAction
  • 其他Action
• 我想从视频中获取角色图像
  • 安装额外依赖
  • 从视频文件中获取图像
  • 从包含视频的文件夹中获取图像
  • 从包含视频的文件夹中获取角色图像
• 我不想让Waifuc占用GPU
  • 如何让waifuc不再占用GPU？
  • waifuc对硬件的最低要求？

Advanced Guides

• Reading Instructions
• Understanding the Waifuc Workflow
  • Let’s Whip Up Some Donuts
  • Source
  • Actions
  • Exporter
• I Need to Dynamically Design the Processing Flow
• How to Customize In Waifuc?
  • Framework Approach
  • Custom Sources
  • Custom Actions
  • Custom Exporters
• What is CCIP, and What are its Features?
  • What is CCIP
  • Known Uses and Limitations of CCIP
  • How CCIPAction Works

Information

• Run Environment Information

API Documentation

• waifuc.config
  • waifuc.config.meta