cloud commited on
Commit
c75f9d3
·
2 Parent(s): e11471f c2d0ada

Merge branch 'main' of https://huggingface.co/cloud19/NSFW_MMaudio

Browse files
Files changed (1) hide show
  1. README.md +70 -3
README.md CHANGED
@@ -1,3 +1,70 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ language: en
4
+ pipeline_tag: text-to-audio
5
+ base_model: hkchengrex/MMAudio
6
+ ---
7
+
8
+ # Fine-tuned MMAudio Model
9
+
10
+ This repository contains a fine-tuned version of the **MMAudio** model, specializing in generating audio from video, image, and text prompts. The model was fine-tuned on a private dataset, resulting in the `cloud19/NSFW_MMaudio` checkpoint. Specializing in NSFW videos of various kinds.
11
+
12
+ **Original Project:** [hkchengrex/MMAudio](https://github.com/hkchengrex/MMAudio)
13
+
14
+ ## Model Details
15
+
16
+ * **Base Architecture:** `large_44k` (from the original MMAudio)
17
+ * **Fine-tuning:** The model was fine-tuned on a private dataset of NSFW content to explore the model's adaptability to specific audio domains. Due to the nature of the training data, the generated audio may reflect mature themes.
18
+ * **Capabilities:** Video-to-Audio, Image-to-Audio, Text-to-Audio.
19
+
20
+ ## How to Use
21
+
22
+ This repository includes a fully functional Gradio (`app.py`). To run it locally, follow these steps. GPU 12-16 GB preferred.
23
+
24
+ **Prerequisites:**
25
+ * Python 3.10+
26
+ * Git and Git LFS (`git-lfs` must be installed)
27
+
28
+ ### Step-by-Step Instructions
29
+
30
+ 1. **Clone the repository:**
31
+ Open your terminal and clone the repository. `git-lfs` will automatically handle downloading the large model file.
32
+
33
+ ```bash
34
+ git clone https://huggingface.co/cloud19/NSFW_MMaudio
35
+ cd NSFW_MMaudio
36
+ ```
37
+
38
+ 2. **Set up a virtual environment (recommended):**
39
+ ```bash
40
+ python -m venv venv
41
+ source venv/bin/activate
42
+ # On Windows, use: venv\Scripts\activate
43
+ ```
44
+
45
+ 3. **Install the required dependencies:**
46
+ The `requirements.txt` file contains all necessary packages.
47
+
48
+ ```bash
49
+ pip install -r requirements.txt
50
+ ```
51
+
52
+ 4. **Run the Gradio application:**
53
+ This will launch a local web server.
54
+
55
+ ```bash
56
+ python app.py
57
+ ```
58
+
59
+ Now you can use the web interface to generate audio with your fine-tuned model.
60
+
61
+ **Limitations:**
62
+ * The model's output is heavily influenced by its training data.
63
+ * **Content Warning:** Due to the NSFW nature of the fine-tuning dataset, the model may generate explicit or mature audio content. User discretion is advised.
64
+ * Like all generative models, it may produce artifacts or unexpected results.
65
+
66
+ ## Original Model Citation
67
+
68
+ All credit for the original architecture, code, and pre-trained models goes to the authors of MMAudio. Please refer to their repository for more details.
69
+
70
+ * **Original GitHub:** [https://github.com/hkchengrex/MMAudio](https://github.com/hkchengrex/MMAudio)