# docs/index.rst Welcome to litcoder’s documentation! ====================================

Getting Started

• Overview
  • Design principles
• Installation
  • Requirements
  • Install
  • Build docs locally
• Quickstart
  • Prerequisites

Tutorials

• Understanding Assemblies in LITcoder
  • What is an Assembly?
  • Assembly Structure
  • Working with Assemblies
  • Key Assembly Methods
  • Exploring Assembly Contents
  • Understanding the Data Flow
  • Assembly Attributes
  • Working with Story Data
  • Using Assemblies in Training
• Word Rate Feature Tutorial
  • Overview
  • Key Components
  • Step-by-Step Tutorial
  • Understanding Word Rate Features
  • Key Parameters
  • Training Configuration
• Language Model Features Tutorial
  • Overview
  • Key Components
  • Step-by-Step Tutorial
  • Understanding Language Model Features
  • Key Parameters
  • Model Options
  • Caching System
  • Training Configuration
• Speech Features Tutorial
  • Overview
  • Key Components
  • Step-by-Step Tutorial
  • Understanding Speech Features
  • Key Parameters
  • Caching System
  • Training Configuration
• Static Embeddings Tutorial
  • Overview
  • Key Components
  • Step-by-Step Tutorial
  • Understanding Static Embeddings
  • Key Parameters
  • Embedding Models
  • File Formats
  • OOV Handling
  • Training Configuration

Guides

• Architecture
  • Data flow
  • Key components
• Assemblies
  • Modules
  • Typical usage
• Features
  • Text features
  • Speech features
  • FIR expansion
  • Example
• Models
  • Core models
  • Training modes
  • Example
• Trainer
  • Configuration
  • Outputs
• Caching
  • Language model activations
  • Speech activations
  • Model artifacts
• Plotting & Logging
  • Logging backends
  • Brain plots

API Reference

• API Reference
  • encoding
  • encoding.assembly
  • encoding.assembly.assemblies
  • encoding.assembly.base_processor
  • encoding.assembly.narratives_processor
  • encoding.assembly.lpp_processor
  • encoding.assembly.lebel_processor
  • encoding.assembly.assembly_loader
  • encoding.assembly.assembly_generator
  • encoding.features
  • encoding.features.factory
  • encoding.features.language_model
  • encoding.features.embeddings
  • encoding.features.speech_model
  • encoding.features.simple_features
  • encoding.features.FIR_expander
  • encoding.downsample
  • encoding.downsample.downsampling
  • encoding.models
  • encoding.models.base
  • encoding.models.ridge_regression
  • encoding.models.linear
  • encoding.models.nested_cv
  • encoding.models.sklearn_model
  • encoding.plotting
  • encoding.plotting.plotting_utils
  • encoding.trainer
  • encoding.utils

Indices and tables

• Index

• Module Index

• Search Page