> ## Documentation Index
> Fetch the complete documentation index at: https://proto.evodesign.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# MSA Generator

> Sample mutations from MSA position-specific distributions

<div class="page-hero">
  <img class="page-hero-banner" src="https://proto-bio.github.io/proto-assets/images/generator/msa/hero.png" alt="MSA Generator" />
</div>

<p class="entity-disclaimer">This generator is open source. Any third-party models, product names, or trademarks referenced are the property of their respective owners, and Proto is not affiliated with them.</p>

<hr class="entity-rule" />

<div class="tool-tab-bar entity-source-bar"><span class="tool-tab-wrap"><span class="tool-tab badge-source entity-source-tab"><svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="16 18 22 12 16 6" /><polyline points="8 6 2 12 8 18" /></svg> Source</span></span></div>

<a href="https://github.com/evo-design/proto-language/blob/d3b7822f74ea64747cc751a3b2ab1aa6b799ac47/proto_language/generator/msa_generator.py#L80" target="_blank" class="tab-panel source-panel entity-source-panel">
  <div class="source-info">
    <img noZoom src="https://github.com/evo-design.png?size=40" class="source-avatar" width="36" height="36" />

    <span class="source-path">evo-design/proto-language<span class="source-subpath">/proto\_language/generator/msa\_generator.py</span></span>
  </div>

  <span class="panel-goto-btn source-goto-btn"><span><svg width="14" height="14" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" /></svg> View source</span></span>
</a>

<div class="entity-contributors"><span class="entity-contributors-label">Generator contributors</span><span class="entity-contributors-people"><a class="entity-contributor" href="https://github.com/dguo8412" target="_blank" rel="noopener" title="dguo8412: 3 commits"><img noZoom class="entity-contributor-avatar" src="https://avatars.githubusercontent.com/u/46211285?v=4&s=64" alt="" loading="lazy" /><span class="entity-contributor-login">dguo8412</span></a></span></div>
Generator that samples mutations from MSA position-specific distributions.

This generator computes empirical probability distributions for each position
in a multiple sequence alignment, then mutates proposal sequences by sampling
from these distributions.

## API Reference

<div class="api-model-section api-model-static api-config-section">
  <div class="api-model-header"><span class="api-model-badge api-config-badge">Config</span><span class="api-model-name">MSAGeneratorConfig</span><a href="https://github.com/evo-design/proto-language/blob/d3b7822f74ea64747cc751a3b2ab1aa6b799ac47/proto_language/generator/msa_generator.py#L15" target="_blank" class="func-table-btn func-source-btn api-model-source"><svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="16 18 22 12 16 6" /><polyline points="8 6 2 12 8 18" /></svg> Source</a></div>

  Configuration object for MSAGenerator.

  This class defines configuration parameters for the MSA generator, which samples
  mutations from position-specific probability distributions derived from a multiple
  sequence alignment.

  <ParamField path="msa" type="MSA" required>
    Multiple sequence alignment (list of aligned sequences).
  </ParamField>

  <ParamField path="num_mutations" type="integer" default="1">
    Number of positions to mutate per sample
  </ParamField>

  <ParamField path="include_gaps" type="boolean" default="False">
    Whether to include gaps when calculating position probabilities
  </ParamField>
</div>

## Usage

```python python icon="python" theme={null}
>>> from proto_language.generator import MSAGenerator, MSAGeneratorConfig
>>> from proto_language.core import Segment
>>> from proto_tools.entities.msa import MSA
>>> config = MSAGeneratorConfig(
...     msa=MSA(aligned_sequences=["MVLS", "AVLS", "MVLS"]),
...     num_mutations=1,
... )
>>> gen = MSAGenerator(config)
>>> segment = Segment(sequence="MVLS", sequence_type="protein")
>>> gen.assign(segment)
>>> gen.sample()  # Position 0 has 2/3 chance of M, 1/3 chance of A
```

## Metadata

| Property                 | Value               |
| ------------------------ | ------------------- |
| Key                      | `msa`               |
| Class                    | `MSAGenerator`      |
| Category                 | `mutation`          |
| Input Type               | `starting_sequence` |
| Uses GPU                 | `False`             |
| Supported Sequence Types | All                 |
| Allows Empty Start       | `False`             |
