Skip to content

Update README.md removing Faster-Whisper references #224

@Coldaine

Description

@Coldaine

Update README.md removing Faster-Whisper references

Overview

Update the project README.md to reflect the migration from the Python-based faster-whisper implementation to the new Rust-based Candle Whisper implementation. This ensures documentation consistency after the STT backend migration.

Background

The migration plan indicates the transition from faster-whisper-rs (Python/PyO3 based) to Candle (pure Rust). The current README contains numerous references to faster-whisper that need to be updated to reflect the new architecture.

Requirements

1. Replace Faster-Whisper References

Update all mentions of faster-whisper in README.md to reference the new Candle Whisper implementation:

  • Replace "faster-whisper" with "Candle Whisper" where appropriate
  • Update plugin descriptions to reflect pure Rust implementation
  • Remove Python-specific installation instructions
  • Update model setup documentation

2. Update Technology Stack Description

Modify the overview section to reflect the new architecture:

  • Update "Faster-Whisper STT" references to "Candle Whisper STT"
  • Remove Python dependency mentions
  • Update the "How It Works" section to reflect pure Rust pipeline
  • Maintain accuracy about local transcription capabilities

3. Model Configuration Updates

Update the "Whisper Model Setup" section:

  • Remove references to Python package installation
  • Update model identifier documentation to reflect Candle compatibility
  • Ensure model path configuration remains accurate
  • Update default model recommendations if needed

4. Documentation Consistency

Ensure the README aligns with:

  • Current plugin status and capabilities
  • Actual build and runtime requirements
  • True feature set after migration
  • Accurate troubleshooting information

Specific Changes Required

Remove/Replace These References:

  • "Python Package: Install the faster-whisper Python package via pip"
  • "Faster-Whisper STT is the default feature"
  • Any PyO3 or Python 3.13 compatibility warnings related to faster-whisper
  • References to the old Python-based implementation

Update Technology Descriptions:

  • Main overview paragraph about STT backend
  • Quick start examples that mention faster-whisper
  • Plugin configuration descriptions
  • Feature capability descriptions

Maintain These Elements:

  • All configuration file paths and formats
  • Model identifier names (tiny.en, base.en, etc.)
  • General ColdVox functionality descriptions
  • Build and installation instructions
  • Troubleshooting for non-STT related issues

Integration Notes

This update should be coordinated with the actual Candle implementation completion to ensure:

  • Documentation matches implemented features
  • Plugin availability status is accurate
  • Configuration options are correctly described
  • Performance characteristics are honestly represented

Acceptance Criteria

  • All faster-whisper references removed or updated to Candle Whisper
  • Python dependency mentions removed from STT context
  • Model setup section updated for pure Rust implementation
  • Quick start examples updated to reflect new backend
  • Technology stack description accurate for new architecture
  • Configuration documentation remains accurate and helpful
  • No broken links or references to deprecated features
  • Documentation style and tone consistent with project standards

References

  • Current README: README.md
  • Migration Plan: docs/plans/stt-candle-whisper-migration.md
  • Whisper Plugin: crates/coldvox-stt/src/plugins/whisper_plugin.rs
  • Model Configuration: docs/whisper-model-configuration.md

Labels

documentation, cleanup, stt, p3

Complexity

Small - Primarily documentation updates with minimal technical complexity, but requires careful attention to maintain accuracy and consistency.


Part of the stt-candle-whisper-migration initiative

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestjulesp2

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions