A comprehensive toolbox for audio & multimodal understanding tasks including ASR, CLAP, audio captioning, speaker identification, speech-llm and more.
๐ Read the Tutorial | ๐ก Examples | ๐ค Models
AudenAI/UTS.AudenAI/auden-asr-zh-stream and AudenAI/auden-asr-zh-enBefore installing Auden:
pip install k2==1.24.4.dev20250714+cuda11.8.torch2.7.1 -f https://k2-fsa.github.io/k2/cuda.html. See the k2 CUDA wheel matrix and the k2 installation guide.git clone https://github.com/AudenAI/Auden.git
cd Auden
pip install -e .
Some examples/ may have extra installation requirements. Please refer to the examples/ READMEs for details.
New to Auden? Check out our comprehensive tutorial to understand the design philosophy and learn how to build your own projects:
๐ Auden Design Philosophy and Usage Guide
The tutorial covers:
AutoModelfrom auden.auto import list_available_models
print(list_available_models())
Important: If you want to load custom models with AutoModel, you must register them first:
from auden.auto import register_model, register_config
# Register your custom model and config
register_model("my-model", "examples.my_model.model", "MyModel")
register_config("my-model", "examples.my_model.config", "MyConfig")
# Now you can use it with AutoModel
from auden.auto import AutoModel
model = AutoModel.from_pretrained("path/to/my-model")
Note: If you don't want to use AutoModel, you can always skip this step and use your own way to load.
Auden provides a HuggingFace-like interface for loading models:
from auden.auto import AutoModel
# Load from HuggingFace Hub
model = AutoModel.from_pretrained("your-org/your-model")
# Load from local checkpoint
model = AutoModel.from_pretrained("path/to/model")
# Load from configuration (creates an EMPTY model)
from auden.auto import AutoConfig
config = AutoConfig.from_pretrained("path/to/config_or_model_dir")
# Important: from_config(...) constructs an EMPTY model (random init) from the config only
# It does NOT load weights. To load weights, use from_pretrained(...)
model = AutoModel.from_config(config)
from auden.auto import AutoConfig
# Load from various sources
config = AutoConfig.from_pretrained("your-org/model")
config = AutoConfig.from_pretrained("path/to/config.json")
# Create config for specific model type
config = AutoConfig.for_model("zipformer", hidden_size=512)
Check examples/ for task-specific tutorials.
The code and weights in this repository are released under the LICENSE file. This repository also includes a NOTICE file with third-party attributions (e.g., Transformers, Icefall).
Auto* APIs and configuration patterns.Python
100.0%
A comprehensive toolbox for audio & multimodal understanding tasks including ASR, CLAP, audio captioning, speaker identification, speech-llm and more.
๐ Read the Tutorial | ๐ก Examples | ๐ค Models
AudenAI/UTS.AudenAI/auden-asr-zh-stream and AudenAI/auden-asr-zh-enBefore installing Auden:
pip install k2==1.24.4.dev20250714+cuda11.8.torch2.7.1 -f https://k2-fsa.github.io/k2/cuda.html. See the k2 CUDA wheel matrix and the k2 installation guide.git clone https://github.com/AudenAI/Auden.git
cd Auden
pip install -e .
Some examples/ may have extra installation requirements. Please refer to the examples/ READMEs for details.
New to Auden? Check out our comprehensive tutorial to understand the design philosophy and learn how to build your own projects:
๐ Auden Design Philosophy and Usage Guide
The tutorial covers:
AutoModelfrom auden.auto import list_available_models
print(list_available_models())
Important: If you want to load custom models with AutoModel, you must register them first:
from auden.auto import register_model, register_config
# Register your custom model and config
register_model("my-model", "examples.my_model.model", "MyModel")
register_config("my-model", "examples.my_model.config", "MyConfig")
# Now you can use it with AutoModel
from auden.auto import AutoModel
model = AutoModel.from_pretrained("path/to/my-model")
Note: If you don't want to use AutoModel, you can always skip this step and use your own way to load.
Auden provides a HuggingFace-like interface for loading models:
from auden.auto import AutoModel
# Load from HuggingFace Hub
model = AutoModel.from_pretrained("your-org/your-model")
# Load from local checkpoint
model = AutoModel.from_pretrained("path/to/model")
# Load from configuration (creates an EMPTY model)
from auden.auto import AutoConfig
config = AutoConfig.from_pretrained("path/to/config_or_model_dir")
# Important: from_config(...) constructs an EMPTY model (random init) from the config only
# It does NOT load weights. To load weights, use from_pretrained(...)
model = AutoModel.from_config(config)
from auden.auto import AutoConfig
# Load from various sources
config = AutoConfig.from_pretrained("your-org/model")
config = AutoConfig.from_pretrained("path/to/config.json")
# Create config for specific model type
config = AutoConfig.for_model("zipformer", hidden_size=512)
Check examples/ for task-specific tutorials.
The code and weights in this repository are released under the LICENSE file. This repository also includes a NOTICE file with third-party attributions (e.g., Transformers, Icefall).
Auto* APIs and configuration patterns.Python
100.0%