From f3982d4ee8ec4b73976fdfb1e27cb598107609b7 Mon Sep 17 00:00:00 2001 From: Yuta Nagano <52748151+yutanagano@users.noreply.github.com> Date: Sat, 31 Aug 2024 11:52:00 +0100 Subject: [PATCH] Reflect calc_residue_representations docstring improvement to docstring in functional API --- src/sceptr/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/sceptr/__init__.py b/src/sceptr/__init__.py index 30fe5fd..fd6743f 100644 --- a/src/sceptr/__init__.py +++ b/src/sceptr/__init__.py @@ -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 ----------