Merge pull request #28 from joelmathewthomas/update/readme
Update/readme
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# freq-split-enhance
|
# freqsplit
|
||||||
|
|
||||||
An evolving **audio processing pipeline** designed to separate and enhance audio components using open-source tools. The project aims to provide a modular framework for working with raw audio files, enabling separation, refinement, and post-processing.
|
An evolving **audio processing pipeline** designed to separate and enhance audio components using open-source tools. The project aims to provide a modular framework for working with raw audio files, enabling separation, refinement, and post-processing.
|
||||||
|
|
||||||
@@ -18,21 +18,25 @@ An evolving **audio processing pipeline** designed to separate and enhance audio
|
|||||||
📁 Project Structure
|
📁 Project Structure
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
freq-split-enhance/
|
freqsplit/
|
||||||
├── api/ # API implementation (future work)
|
├── api/ # API implementation (future work)
|
||||||
├── client/ # Client-side interactions (future work)
|
├── client/ # Client-side interactions (future work)
|
||||||
├── src/ # Core processing modules
|
├── LICENSE # License file
|
||||||
│ ├── input/ # Audio input handling
|
├── pyproject.toml # Project metadata and dependencies
|
||||||
│ ├── preprocessing/ # Normalization, resampling, trimming
|
├── pytest.ini # Pytest configuration
|
||||||
│ ├── separation/ # Source separation with Demucs
|
|
||||||
│ ├── postprocessing/ # Post-processing and saving results
|
|
||||||
│ ├── refinement/ # Noise reduction and enhancement
|
|
||||||
│ ├── spectogram/ # Spectrogram generation and analysis
|
|
||||||
├── tests/ # Unit tests
|
|
||||||
├── requirements.txt # Dependencies
|
|
||||||
├── README.md # Project documentation
|
├── README.md # Project documentation
|
||||||
├── LICENSE # License information
|
├── requirements.txt # Python dependencies
|
||||||
└── pytest.ini # Pytest configuration
|
├── src/ # Core processing modules
|
||||||
|
│ ├── freqsplit/ # Main package directory
|
||||||
|
│ │ ├── __init__.py # Package initialization
|
||||||
|
│ │ ├── input/ # Audio input handling
|
||||||
|
│ │ ├── preprocessing/ # Normalization, resampling, trimming
|
||||||
|
│ │ ├── separation/ # Source separation with Demucs
|
||||||
|
│ │ ├── postprocessing/ # Post-processing and saving results
|
||||||
|
│ │ ├── refinement/ # Spectrogram-based enhancement
|
||||||
|
│ │ ├── spectogram/ # Spectrogram generation and analysis
|
||||||
|
├── tests/ # Unit and integration tests
|
||||||
|
└── venv/ # Virtual environment (should be excluded from version control)
|
||||||
```
|
```
|
||||||
|
|
||||||
### 📝 Wiki
|
### 📝 Wiki
|
||||||
|
|||||||
Reference in New Issue
Block a user