Text Generation
Transformers
Safetensors
English
Chinese
Russian
yue2
music-generation
orbitquant
quantization
4-bit precision
custom-code
8-bit precision
Instructions to use WaveCut/YuE2-3B-OrbitQuant-W4A4 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use WaveCut/YuE2-3B-OrbitQuant-W4A4 with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="WaveCut/YuE2-3B-OrbitQuant-W4A4")# Load model directly from transformers import AutoModelForCausalLM model = AutoModelForCausalLM.from_pretrained("WaveCut/YuE2-3B-OrbitQuant-W4A4", device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use WaveCut/YuE2-3B-OrbitQuant-W4A4 with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "WaveCut/YuE2-3B-OrbitQuant-W4A4" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "WaveCut/YuE2-3B-OrbitQuant-W4A4", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/WaveCut/YuE2-3B-OrbitQuant-W4A4
- SGLang
How to use WaveCut/YuE2-3B-OrbitQuant-W4A4 with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "WaveCut/YuE2-3B-OrbitQuant-W4A4" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "WaveCut/YuE2-3B-OrbitQuant-W4A4", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "WaveCut/YuE2-3B-OrbitQuant-W4A4" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "WaveCut/YuE2-3B-OrbitQuant-W4A4", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use WaveCut/YuE2-3B-OrbitQuant-W4A4 with Docker Model Runner:
docker model run hf.co/WaveCut/YuE2-3B-OrbitQuant-W4A4
File size: 10,942 Bytes
b35ab1f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | function(accumulate_gpu_archs OUT_ACC ACC EXTRA_ARCHS)
list(APPEND ACC ${EXTRA_ARCHS})
list(REMOVE_DUPLICATES ACC)
list(SORT ACC)
set(${OUT_ACC} ${ACC} PARENT_SCOPE)
endfunction()
function(cuda_kernel_component SRC_VAR)
set(oneValueArgs CUDA_MINVER NAME)
set(multiValueArgs SOURCES INCLUDES CUDA_CAPABILITIES CUDA_FLAGS CXX_FLAGS)
cmake_parse_arguments(KERNEL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT KERNEL_SOURCES)
message(FATAL_ERROR "cuda_kernel_component: SOURCES argument is required")
endif()
# Bail out if this component is not supported by the CUDA version.
if(KERNEL_CUDA_MINVER)
if(CUDA_VERSION VERSION_LESS ${KERNEL_CUDA_MINVER})
return()
endif()
endif()
set(_KERNEL_SRC ${KERNEL_SOURCES})
if(KERNEL_INCLUDES)
# TODO: check if CLion support this:
# https://youtrack.jetbrains.com/issue/CPP-16510/CLion-does-not-handle-per-file-include-directories
set_source_files_properties(
${_KERNEL_SRC}
PROPERTIES INCLUDE_DIRECTORIES "${KERNEL_INCLUDES}")
endif()
# Determine CUDA architectures
if(KERNEL_CUDA_CAPABILITIES)
cuda_archs_loose_intersection(_KERNEL_ARCHS "${KERNEL_CUDA_CAPABILITIES}" "${CUDA_ARCHS}")
if(NOT _KERNEL_ARCHS)
message(FATAL_ERROR "CUDA kernel: ${KERNEL_NAME}, empty set of capabilities after intersection (kernel: ${KERNEL_CUDA_CAPABILITIES}, supported: ${CUDA_ARCHS})")
endif()
else()
set(_KERNEL_ARCHS "${CUDA_KERNEL_ARCHS}")
endif()
message(STATUS "CUDA kernel: ${KERNEL_NAME}, capabilities: ${_KERNEL_ARCHS}")
set_gencode_flags_for_srcs(SRCS "${_KERNEL_SRC}" CUDA_ARCHS "${_KERNEL_ARCHS}")
accumulate_gpu_archs(_ALL_GPU_ARCHS "${ALL_GPU_ARCHS}" "${_KERNEL_ARCHS}")
set(ALL_GPU_ARCHS ${_ALL_GPU_ARCHS} PARENT_SCOPE)
# Apply CUDA-specific compile flags
if(KERNEL_CUDA_FLAGS)
set(_CUDA_FLAGS "${KERNEL_CUDA_FLAGS}")
# -static-global-template-stub is not supported on CUDA < 12.8. Remove this
# once we don't support CUDA 12.6 anymore.
if(CUDA_VERSION VERSION_LESS 12.8)
string(REGEX REPLACE "-static-global-template-stub=(true|false)" "" _CUDA_FLAGS "${_CUDA_FLAGS}")
endif()
foreach(_SRC ${_KERNEL_SRC})
if(_SRC MATCHES ".*\\.cu$")
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CUDA>:${_CUDA_FLAGS}>"
)
endif()
endforeach()
endif()
# Apply CXX-specific compile flags
if(KERNEL_CXX_FLAGS)
foreach(_SRC ${_KERNEL_SRC})
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CXX>:${KERNEL_CXX_FLAGS}>"
)
endforeach()
endif()
set(_TMP_SRC ${${SRC_VAR}})
list(APPEND _TMP_SRC ${_KERNEL_SRC})
set(${SRC_VAR} ${_TMP_SRC} PARENT_SCOPE)
endfunction()
function(hip_kernel_component SRC_VAR)
set(options SUPPORTS_HIPIFY)
set(oneValueArgs CUDA_MINVER NAME)
set(multiValueArgs SOURCES INCLUDES CXX_FLAGS HIP_FLAGS ROCM_ARCHS)
cmake_parse_arguments(KERNEL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT KERNEL_SOURCES)
message(FATAL_ERROR "hip_kernel_component: SOURCES argument is required")
endif()
set(_KERNEL_SRC ${KERNEL_SOURCES})
if(KERNEL_INCLUDES)
# TODO: check if CLion support this:
# https://youtrack.jetbrains.com/issue/CPP-16510/CLion-does-not-handle-per-file-include-directories
set_source_files_properties(
${_KERNEL_SRC}
PROPERTIES INCLUDE_DIRECTORIES "${KERNEL_INCLUDES}")
endif()
# Apply HIP-specific compile flags
if(KERNEL_HIP_FLAGS)
foreach(_SRC ${_KERNEL_SRC})
if(_SRC MATCHES ".*\\.(cu|hip)$")
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:HIP>:${KERNEL_HIP_FLAGS}>"
)
endif()
endforeach()
endif()
# Determine ROCm architectures
if(KERNEL_ROCM_ARCHS)
hip_archs_loose_intersection(_KERNEL_ARCHS "${KERNEL_ROCM_ARCHS}" "${ROCM_ARCHS}")
if(NOT _KERNEL_ARCHS)
message(FATAL_ERROR "ROCm kernel: ${KERNEL_NAME}, empty set of architectures after intersection (kernel: ${KERNEL_ROCM_ARCHS}, supported: ${ROCM_ARCHS})")
endif()
else()
set(_KERNEL_ARCHS "${ROCM_ARCHS}")
endif()
message(STATUS "ROCm kernel: ${KERNEL_NAME}, archs: ${_KERNEL_ARCHS}")
accumulate_gpu_archs(_ALL_GPU_ARCHS "${ALL_GPU_ARCHS}" "${_KERNEL_ARCHS}")
set(ALL_GPU_ARCHS ${_ALL_GPU_ARCHS} PARENT_SCOPE)
foreach(_SRC ${_KERNEL_SRC})
if(_SRC MATCHES ".*\\.(cu|hip)$")
foreach(_ARCH ${_KERNEL_ARCHS})
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:HIP>:--offload-arch=${_ARCH}>"
)
endforeach()
endif()
endforeach()
set(_TMP_SRC ${${SRC_VAR}})
list(APPEND _TMP_SRC ${_KERNEL_SRC})
set(${SRC_VAR} ${_TMP_SRC} PARENT_SCOPE)
endfunction()
function(xpu_kernel_component SRC_VAR)
set(options)
set(oneValueArgs)
set(multiValueArgs SOURCES INCLUDES CXX_FLAGS SYCL_FLAGS)
cmake_parse_arguments(KERNEL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT KERNEL_SOURCES)
message(FATAL_ERROR "xpu_kernel_component: SOURCES argument is required")
endif()
set(_KERNEL_SRC ${KERNEL_SOURCES})
# Handle per-file include directories if specified
if(KERNEL_INCLUDES)
# TODO: check if CLion support this:
# https://youtrack.jetbrains.com/issue/CPP-16510/CLion-does-not-handle-per-file-include-directories
set_source_files_properties(
${_KERNEL_SRC}
PROPERTIES INCLUDE_DIRECTORIES "${KERNEL_INCLUDES}")
endif()
# Apply CXX-specific compile flags
if(KERNEL_CXX_FLAGS)
foreach(_SRC ${_KERNEL_SRC})
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CXX>:${KERNEL_CXX_FLAGS}>"
)
endforeach()
endif()
# Add SYCL-specific compilation flags for XPU sources
if(KERNEL_SYCL_FLAGS)
# Use kernel-specific SYCL flags plus SYCL flags from the parent scope.
set(_SYCL_FLAGS ${sycl_flags})
list(APPEND _SYCL_FLAGS ${KERNEL_SYCL_FLAGS})
foreach(_SRC ${_KERNEL_SRC})
if(_SRC MATCHES ".*\\.(cpp|cxx|cc)$")
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CXX>:${_SYCL_FLAGS}>"
)
endif()
endforeach()
else()
# Use default SYCL flags (from parent scope variable sycl_flags)
foreach(_SRC ${_KERNEL_SRC})
if(_SRC MATCHES ".*\\.(cpp|cxx|cc)$")
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CXX>:${sycl_flags}>"
)
endif()
endforeach()
endif()
# Append to parent scope SRC variable
set(_TMP_SRC ${${SRC_VAR}})
list(APPEND _TMP_SRC ${_KERNEL_SRC})
set(${SRC_VAR} ${_TMP_SRC} PARENT_SCOPE)
endfunction()
function(cpu_kernel_component SRC_VAR)
set(options)
set(oneValueArgs)
set(multiValueArgs SOURCES INCLUDES CXX_FLAGS)
cmake_parse_arguments(KERNEL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT KERNEL_SOURCES)
message(FATAL_ERROR "cpu_kernel_component: SOURCES argument is required")
endif()
set(_KERNEL_SRC ${KERNEL_SOURCES})
# Handle per-file include directories if specified
if(KERNEL_INCLUDES)
# TODO: check if CLion support this:
# https://youtrack.jetbrains.com/issue/CPP-16510/CLion-does-not-handle-per-file-include-directories
set_source_files_properties(
${_KERNEL_SRC}
PROPERTIES INCLUDE_DIRECTORIES "${KERNEL_INCLUDES}")
endif()
# Apply CXX-specific compile flags
if(KERNEL_CXX_FLAGS)
foreach(_SRC ${_KERNEL_SRC})
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CXX>:${KERNEL_CXX_FLAGS}>"
)
endforeach()
endif()
# Append to parent scope SRC variable
set(_TMP_SRC ${${SRC_VAR}})
list(APPEND _TMP_SRC ${_KERNEL_SRC})
set(${SRC_VAR} ${_TMP_SRC} PARENT_SCOPE)
endfunction()
function(metal_kernel_component SRC_VAR)
set(options)
set(oneValueArgs)
set(multiValueArgs SOURCES INCLUDES CXX_FLAGS)
cmake_parse_arguments(KERNEL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT KERNEL_SOURCES)
message(FATAL_ERROR "metal_kernel_component: SOURCES argument is required")
endif()
set(_KERNEL_SRC ${KERNEL_SOURCES})
# Separate Metal shader files from other sources
set(_METAL_SRC)
set(_CPP_SRC)
foreach(_SRC_FILE IN LISTS _KERNEL_SRC)
if(_SRC_FILE MATCHES "\\.(metal|h)$")
list(APPEND _METAL_SRC ${_SRC_FILE})
else()
list(APPEND _CPP_SRC ${_SRC_FILE})
endif()
endforeach()
# Handle per-file include directories if specified (for C++ sources only)
if(KERNEL_INCLUDES AND _CPP_SRC)
# TODO: check if CLion support this:
# https://youtrack.jetbrains.com/issue/CPP-16510/CLion-does-not-handle-per-file-include-directories
set_source_files_properties(
${_CPP_SRC}
PROPERTIES INCLUDE_DIRECTORIES "${KERNEL_INCLUDES}")
endif()
# Apply CXX-specific compile flags
if(KERNEL_CXX_FLAGS AND _CPP_SRC)
foreach(_SRC ${_CPP_SRC})
set_property(
SOURCE ${_SRC}
APPEND PROPERTY
COMPILE_OPTIONS "$<$<COMPILE_LANGUAGE:CXX>:${KERNEL_CXX_FLAGS}>"
)
endforeach()
endif()
# Add C++ sources to main source list
if(_CPP_SRC)
set(_TMP_SRC ${${SRC_VAR}})
list(APPEND _TMP_SRC ${_CPP_SRC})
set(${SRC_VAR} ${_TMP_SRC} PARENT_SCOPE)
endif()
# Keep track of Metal sources for later compilation
if(_METAL_SRC)
set(_TMP_METAL ${ALL_METAL_SOURCES})
list(APPEND _TMP_METAL ${_METAL_SRC})
set(ALL_METAL_SOURCES ${_TMP_METAL} PARENT_SCOPE)
endif()
# Keep the includes directory for the Metal sources
if(KERNEL_INCLUDES AND _METAL_SRC)
set(_TMP_METAL_INCLUDES ${METAL_INCLUDE_DIRS})
list(APPEND _TMP_METAL_INCLUDES ${KERNEL_INCLUDES})
set(METAL_INCLUDE_DIRS ${_TMP_METAL_INCLUDES} PARENT_SCOPE)
endif()
endfunction()
|