feat: create Circuit-Forge/cf-voice repo with stub VoiceFrame API #39
Labels
No labels
architecture
backlog
enhancement
module:documents
module:hardware
module:manage
module:pipeline
module:voice
priority:backlog
priority:high
priority:medium
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: Circuit-Forge/circuitforge-core#39
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Context
Linnet (Notation v0.1.x) and Osprey both need
cf_voice. Architecture decision: standalone repo, not a cf-core module (see #35).Approach: create the repo immediately with a stub
VoiceFramethat returns synthetic tone events. Linnet builds against the real import path from day one using the stub, then cf-voice classifiers are filled in incrementally.Deliverables for this ticket
Circuit-Forge/cf-voicerepo (public, MIT for IO layer / BSL for inference layer)VoiceFramedataclass:label: str,confidence: float,speaker_id: str,shift_magnitude: float,timestamp: floatcf_voice.io— returns syntheticVoiceFrameevents on a timer (no real audio)cf_voice.context— wraps stub IO, passes throughVoiceFrame--mock-voiceflag / env varCF_VOICE_MOCK=1that activates stub modepyproject.tomlwith versioned package (cf-voice)VoiceFrameAPI docsVoiceFrame API contract
Install target
Linnet will install via:
pip install -e ../cf-voice(editable, same pattern as cf-core)Consumed by
Circuit-Forge/linnet(Notation v0.1.x) — first consumerCircuit-Forge/osprey— second consumer (telephony path)Blocking
Circuit-Forge/linnet#3,Circuit-Forge/linnet#4,Circuit-Forge/linnet#5Shipped in Circuit-Forge/cf-voice @ 35fc0a0.
VoiceFramedataclass withis_reliable()andis_shift()helpersMockVoiceIO— async generator of synthetic frames, activated byCF_VOICE_MOCK=1ContextClassifier— passthrough stub;_enrich()hook ready for YAMNet/wav2vec2make_io()factory with env-based mock detectionInstall:
pip install -e ../cf-voiceLinnet#3, #4, #5 can now unblock.