Skip to content

Commit

Permalink
Reflect calc_residue_representations docstring improvement to docstri…
Browse files Browse the repository at this point in the history
…ng in functional API
  • Loading branch information
yutanagano committed Aug 31, 2024
1 parent 0c8410e commit f3982d4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/sceptr/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ def calc_vector_representations(instances: DataFrame) -> ndarray:

def calc_residue_representations(instances: DataFrame) -> ResidueRepresentations:
"""
Given multiple TCRs, map each TCR to a set of amino acid residue-level representations.
The residue-level representations are taken from the output of the penultimate self-attention layer, and are the same ones used by the :py:func:`~sceptr.variant.average_pooling` variant when generating TCR receptor-level representations.
Map each TCR to a set of amino acid residue-level representations.
The residue-level representations are the output of the penultimate self-attention layer, as also used by the :py:func:`~sceptr.variant.average_pooling` variant when generating TCR receptor-level representations.
Parameters
----------
Expand Down

0 comments on commit f3982d4

Please # to comment.