Skip to content

Commit

Permalink
trying to fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drewschaub committed Dec 30, 2024
1 parent f9a2330 commit e7a46ad
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
2 changes: 2 additions & 0 deletions protein_design_tools/core/protein_structure.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ def get_coordinates(
-------
np.ndarray
Array of coordinates.
"""

# 1) Merge chain(s) info into a selection dictionary if needed
Expand Down Expand Up @@ -149,6 +150,7 @@ def remove_residues_by_name(self, residue_name: str) -> None:
----------
residue_name : str
Residue name to be removed (e.g. 'HOH' for water).
"""
for chain in self.chains:
# Keep only residues whose name != residue_name
Expand Down
3 changes: 3 additions & 0 deletions protein_design_tools/io/pdb.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def fetch_pdb(
-------
ProteinStructure
The parsed protein structure.
"""
structure = ProteinStructure(name=name)

Expand Down Expand Up @@ -72,6 +73,7 @@ def read_pdb(
-------
ProteinStructure
The parsed protein structure.
"""
structure = ProteinStructure(name=name)

Expand Down Expand Up @@ -110,6 +112,7 @@ def _parse_pdb_content(
-------
ProteinStructure
The populated ProteinStructure object.
"""
for line in content:
if line.startswith("ATOM") or line.startswith("HETATM"):
Expand Down
6 changes: 3 additions & 3 deletions protein_design_tools/metrics/tmscore.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


@jit
def compute_tm_score_jax(P: jnp.ndarray, Q: jnp.ndarray) -> jnp.ndarray:
def compute_tmscore_jax(P: jnp.ndarray, Q: jnp.ndarray) -> jnp.ndarray:
"""
Compute TM-score between two NxD JAX arrays using JIT compilation.
Expand All @@ -30,7 +30,7 @@ def compute_tm_score_jax(P: jnp.ndarray, Q: jnp.ndarray) -> jnp.ndarray:
return tm_score


def compute_tm_score_numpy(P: np.ndarray, Q: np.ndarray) -> float:
def compute_tmscore_numpy(P: np.ndarray, Q: np.ndarray) -> float:
"""
Compute TM-score between two NxD NumPy arrays.
Expand All @@ -55,7 +55,7 @@ def compute_tm_score_numpy(P: np.ndarray, Q: np.ndarray) -> float:
return tm_score


def compute_tm_score_pytorch(P: torch.Tensor, Q: torch.Tensor) -> torch.Tensor:
def compute_tmscore_pytorch(P: torch.Tensor, Q: torch.Tensor) -> torch.Tensor:
"""
Compute TM-score between two NxD PyTorch tensors.
Expand Down

0 comments on commit e7a46ad

Please sign in to comment.