Skip to main content

Using Custom Models

Learn how to create and manage custom language models in Scriptix.

What Are Custom Models?​

Custom models are specialized speech recognition models that you can train with your own audio data to improve accuracy for domain-specific terminology and vocabulary.

Accessing Custom Models​

  1. Navigate to Custom Models page
  2. View all your organization's custom models in data grid

Custom Models Page​

Models List​

The data grid displays custom models with columns:

Name:

  • Custom model name
  • Click to open model details
  • Editable in model details

Training Status:

  • Color-coded badge showing current status
  • Zinc (Not Running) - Model created, not trained
  • Amber (Ready to Run) - Ready to begin training
  • Sky (Running) - Currently training
  • Emerald (Success) - Training completed successfully
  • Red (Failed) - Training failed

Base Language:

  • Language the model is trained for
  • Shows full language name (e.g., "English")
  • Info tooltip: "The language this custom model is based on. You'll select this model variant when uploading."

Last Modified:

  • Most recent update date
  • Formatted date display

Actions​

Edit (Pencil Icon):

  • Opens model details page
  • Available to all users
  • View training status and manage datasets

Delete (Trash Icon):

  • Removes the custom model
  • Available only to ORGADMIN and SYSOP roles
  • Other roles do not see delete action
  • Permanent deletion

Pagination​

  • 25 items per page (default)
  • Options: 25, 50, 75, 100 per page
  • Manual pagination controls
  • Shows total results

Page Header​

Title: "Custom models"

Caption: "Create custom models"

Buttons:

  • Getting Started (Help icon) - Opens guide modal
  • New Custom Model (Plus icon) - Opens create modal

Info Banner​

Banner displays at top of page with information:

  • Title: "About Custom Models"
  • Custom models allow fine-tuning for specific use cases
  • Training easy with audio files and matching transcripts
  • Link to Force Alignment feature
  • Trained models recognize specific terms accurately
  • After training succeeds, select model in language list

Creating a Custom Model​

Open Create Modal​

  1. Click "New Custom Model" button (Plus icon)
  2. Modal opens with title "New custom model"

Fill Form​

Model Name (Required):

  • Text input field
  • Enter descriptive name for model
  • Example: "Medical EN", "Legal NL"

Language (Required):

  • Dropdown select
  • Shows trainable languages only
  • Must select base language

Create​

  1. Fill in name and select language
  2. Click "Create" button
  3. Create button disabled if:
    • Name empty
    • Language not selected
    • Already creating (loading state)
    • Organization not loaded
  4. Modal closes on success
  5. Model appears in list with "Not Running" status
  6. Toast: "Custom model created successfully"

Form Fields​

Form ID: create-custom-model-form

Name Input:

  • Label: "Name"
  • Placeholder: "Name"
  • Type: text
  • Required field

Language Select:

  • Label: "Language"
  • Single select dropdown
  • Options from trainable languages API
  • Shows language name as label
  • Language ID as value

Close Button:

  • Label: "Close"
  • Variant: smoke
  • Closes modal without creating

Create Button:

  • Label: "Create"
  • Variant: primary
  • Type: submit
  • Disabled when fields incomplete

Getting Started Guide​

First-time visit shows guide modal automatically.

Guide Modal:

  • Title: "Getting started with custom models"
  • Four sections with icons
  • Shows on first page visit
  • Stored in localStorage: customModelsGuideShown

Guide Sections:

  1. What are custom models (Sparkles icon)

    • Train custom language models with your data
    • Improve accuracy for specific terms and vocabulary

  2. What you need (FileText icon)

    • Audio files paired with accurate transcripts
    • More accurate data = better results

  3. Only have audio files (FileAudio icon)

    • Use Force Alignment to add timestamps
    • Available in workspace

  4. After training (CheckCircle icon)

    • Select custom model from language dropdown
    • Use when uploading new files

Access Guide:

  • Click "Getting Started" button in header
  • Modal reopens on button click
  • Click "Got it" to close

Managing Custom Models​

View Model Details​

  1. Click model name in list
  2. Or click Edit (pencil) action
  3. Opens model details page
  4. Shows:
    • Model name (editable)
    • Training status badge
    • Base language (read-only)
    • Last modified date
    • Datasets list
    • Training controls

Delete Custom Model​

Who Can Delete:

  • ORGADMIN role users only
  • SYSOP role users only
  • Other roles do not see delete action

Delete Process:

  1. Click Delete (trash) icon on model row
  2. Confirmation modal appears
    • Title: "Delete confirmation"
    • Message: "Are you sure you want to delete this model?"
  3. Click "Delete" to confirm
  4. Or click "Cancel" to abort
  5. Model permanently removed
  6. Toast: "Custom model deleted successfully"

Delete Confirmation:

  • Size: small modal
  • Destructive: true (red confirm button)
  • Auto-focus on confirm button
  • Cannot be undone

Training Status Details​

Not Running (1)​

Badge Color: Zinc (gray)

What It Means:

  • Model created but not trained
  • No datasets uploaded yet
  • Initial state after creation

Next Step:

  • Open model details
  • Upload datasets
  • Start training

Ready to Run (2)​

Badge Color: Amber (orange/yellow)

What It Means:

  • Datasets uploaded
  • Training queued
  • Will start automatically

What Appears:

  • "Train the Language" button hidden
  • Cannot manually trigger

Running (3)​

Badge Color: Sky (blue)

What It Means:

  • Training actively in progress
  • System processing data
  • Cannot interrupt

What Appears:

  • "Train the Language" button hidden
  • Cannot modify during training

Success (4)​

Badge Color: Emerald (green)

What It Means:

  • Training completed successfully
  • Model ready to use
  • Can be selected for transcription

What Appears:

  • "Train the Language" button hidden
  • Model available in language dropdown

Failed (5)​

Badge Color: Red

What It Means:

  • Training encountered error
  • Model not usable
  • Needs attention

What Appears:

  • "Train the Language" button visible
  • Can upload new datasets and retry

Using Trained Models​

After training status shows "Success" (4):

  1. Model available for transcription
  2. Select model when creating transcripts
  3. Improved accuracy for trained vocabulary

Selection:

  • Models appear in language selection
  • Custom models show with base language
  • Select when uploading audio files

Page Features​

Data Grid Settings​

Row Selection: Disabled

Pagination:

  • Enabled
  • Manual pagination
  • Server-side

Sorting:

  • Enabled
  • Manual sorting
  • Server-side

Filtering:

  • Enabled
  • Manual filtering
  • Server-side
  • Column filters hidden
  • Filter mode: popover

Display:

  • Height: 79vh
  • Dense mode enabled
  • Grid mode disabled
  • Striped rows enabled
  • Loading state shown

Page Size:

  • Default: 25 rows
  • Options: 25, 50, 75, 100

Cell Click Behavior​

Clicking on these fields opens model details:

  • Name cell
  • Base language key cell
  • Key cell

Role-Based Access​

All Authenticated Users:

  • View custom models list
  • Create new models
  • Edit models
  • View model details
  • Upload datasets
  • Train models

ORGADMIN and SYSOP Only:

  • Delete custom models
  • Delete action in dropdown menu

Info Banner Content​

Banner shows at page top:

Title: "About Custom Models"

Content:

  • Custom models allow fine-tuning for specific use case
  • Training easy with audio and matching transcripts
  • Use Force Alignment if no timestamps (links to Home)
  • Trained models recognize specific terms accurately
  • Select model in language list after training succeeds

Create custom models! Train specialized models for improved transcription accuracy.

Note: Custom model features and availability may vary based on your subscription plan. Training capacity, model limits, and advanced features depend on your organization's plan. Contact your administrator for details about custom model access.

Next Steps​