Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aitronz committed Nov 17, 2023
1 parent fd66bde commit dd387e2
Show file tree
Hide file tree
Showing 16 changed files with 104 additions and 0 deletions.
7 changes: 7 additions & 0 deletions faq/conda/alternative.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
order: F
---

# General Failure After Installation

If all else fails, download and install the manager's runtime (the fourth option in the manager). This will install the runtime but the tensorboard will not be available. To use the tensorboard, you need to use the conda option.
8 changes: 8 additions & 0 deletions faq/conda/conda.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
expanded: false
order: B
---

# Conda

Here you have all the frequent asked questions about conda depdendency option
6 changes: 6 additions & 0 deletions faq/conda/conda_error_cannot_build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
order: E
---
# Conda Error Building Wheels

If Conda shows an error related to the "Wheels" dependency, check that Visual Studio Build Tools are installed. This requirement is mentioned at the beginning of the installer.
22 changes: 22 additions & 0 deletions faq/conda/dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
order: A
---

# Dependencies
In this section you will found the rquired or no required dependencies to run the conda installation of Applio.

!!!info Info!
The explanation of how to install the dependencies is in [Requirements](../../installation/requirements.md) section.
!!!

## Git

Git is **not required** for the installer to function. The installer automatically downloads Mingit, eliminating the need for Git to be pre-installed.

## Python

Python is **not required** for the installer to function. The installer utilizes Conda, so there's no need to have Python installed beforehand.

## Visual Studio Build Tools

[Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_buildtools.exe) **are required** for the installer to function. This requirement is mentioned at the beginning of the installer.
7 changes: 7 additions & 0 deletions faq/conda/error_downloading_miniconda.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
order: C
---

# Error Downloading Miniconda

If there are issues automatically downloading Miniconda, download it [manually](https://repo.anaconda.com/miniconda/Miniconda3-py39_23.9.0-0-Windows-x86_64.exe) and install it.
11 changes: 11 additions & 0 deletions faq/conda/mingit_extraction_or_download_issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
order: D
---

# Issues with Mingit Extraction or Download

If there are problems extracting Mingit or download errors preventing progress, manually download the Mingit ZIP file. Make sure to delete the Appio folder if any issues arise.

## Alternative for Persistent Mingit Issues

If Mingit problems persist, manually install Git. This may be necessary if the repository copy isn't successful.
6 changes: 6 additions & 0 deletions faq/conda/tensorboard_error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
order: B
---
# Tensorboard or dependency error

If an error related to Tensorboard occurs, it's likely that no dependencies were installed correctly. Review the dependencies page in the FAQ of conda and ensure all dependencies are installed properly.
4 changes: 4 additions & 0 deletions faq/colab-disconnect.md → faq/general/colab_disconnect.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
order: 1
---

# Situation with Google Colab

Unfortunately, Google Colab is currently unavailable as Google has taken measures to restrict access to Colab services, including Applio. We kindly request that you refrain from asking this question in the future as the situation remains unchanged.
4 changes: 4 additions & 0 deletions faq/epoch.md → faq/general/epoch.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
order: 2
---

# Epoch

An Epoch is the number of iterations performed during training to complete one full cycle of your dataset. For example, if you have a dataset of 200 audio samples and you set a batch_size of 10, 10 audio samples will be processed in each iteration. To process all 200 audio samples, you will need to perform 20 iterations in total. This complete cycle is referred to as one epoch.
8 changes: 8 additions & 0 deletions faq/general/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
expanded: false
order: A
---

# General

Questions about RVC/Applio in general
4 changes: 4 additions & 0 deletions faq/pitch-extraction.md → faq/general/pitch_extraction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
order: 3
---

# Pitch extraction differences

- **pm:** It provides a quick but inefficient result and is less faithful to the voice model.
Expand Down
4 changes: 4 additions & 0 deletions faq/tensorboard.md → faq/general/tensorboard.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
order: 4
---

# Tensorboard

Tensorboard is a series of graphs where we can monitor the progress of our model during training, but there are many graphs. We are only interested in the graph called 'g/total'. You can find this by clicking on 'inactive' and selecting 'scalars'. Then, go to the last page, where you will find it in the last graph.
File renamed without changes.
File renamed without changes.
9 changes: 9 additions & 0 deletions faq/runtimelocal/runtimelocal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
expanded: false
order: C
---


# Runtime or Local Python

Some questions about the runtime or local Python.
4 changes: 4 additions & 0 deletions installation/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ After installing everything, it is recommended to restart your PC.

# Requirements

!!!warning Advice!
These are the old and general requirements for the installation with the "Runtime" option. If you are using the "Conda" (new installer), see the [Conda](../faq/conda/dependencies.md) section.
!!!

1. [Buildtools](https://aka.ms/vs/17/release/vs_BuildTools.exe)

- Download the file and execute it.
Expand Down

0 comments on commit dd387e2

Please sign in to comment.