sinusoidal-positional-encoding-design
License: restricted — no clear open-source license detected for the underlying tool; verify licensing before commercial use or redistribution.
Summary
Design and implement a sinusoidal embedder that encodes MS/MS peak m/z and intensity metadata into fixed-length tensor representations for transformer input. This skill is essential when building transformer-based models for mass spectrometry data where peak positions and magnitudes must be converted into learnable token embeddings.
When to use
You have variable-length lists of MS/MS peaks (m/z and intensity pairs) that need to be encoded into a fixed-dimensional representation compatible with transformer architecture. Use this skill when your downstream model requires position-aware and magnitude-aware embeddings of mass spectrometry spectral data, and when contrastive learning or attention mechanisms depend on structured peak metadata.
When NOT to use
- Peak data is already pre-embedded or represents a feature table incompatible with sinusoidal encoding.
- Your model does not use transformer architecture or does not require position-aware embeddings.
- MS/MS data has been heavily binned or discretized into fixed-size histogram bins (use existing bin indices instead).
Inputs
- m/z array (mass-to-charge ratio values, typically numpy array or tensor)
- intensity array (peak intensity values, aligned with m/z array)
- peak metadata (optional: retention time, adduct type, or other spectral properties)
- variable-length peak lists (ragged or padded)
Outputs
- fixed-length tensor embeddings compatible with transformer input
- embedding tensor of shape (batch_size, max_peaks, embedding_dim)
- normalized embeddings with documented numerical range
How to apply
Define sinusoidal basis functions at multiple frequency scales to encode peak m/z and intensity values independently, following the standard transformer positional encoding pattern. Normalize input peak m/z and intensity arrays to consistent ranges (typically [0, 1] or standardized). Implement the embedder as a callable module that accepts raw peak metadata and outputs fixed-length tensors. Validate that embeddings have the correct shape, numerical range within expected bounds, and exhibit orthogonality properties across frequency dimensions. Handle variable-length peak lists through padding or masking, and confirm deterministic output for identical inputs.
Related tools
- PyTorch (Tensor computation and neural module implementation for the sinusoidal embedder)
- matchms (MS/MS spectrum object handling and peak metadata extraction)
- CLERMS (Reference implementation of sinusoidal embedder integrated with contrastive learning and transformer backbone) — github.com/HaldamirS/CLERMS
Examples
python model.ipynb # After running dataset_preprocessing.ipynb and cal_tanimoto_score.ipynb to normalize peaks; embedder processes m/z and intensity arrays into fixed-length tensors for CLERMS transformer training.
Evaluation signals
- Embedding tensor shape matches (batch_size, num_peaks, embedding_dim) with no ragged dimensions.
- Numerical values lie within expected range (e.g., ±1.0 for standard sinusoidal encoding) and do not contain NaN or Inf.
- Orthogonality check: dot product between embedding vectors from different frequency scales is near zero.
- Determinism: identical peak lists produce identical embeddings across repeated runs.
- Variable-length handling: padded or masked embeddings produce valid transformer attention weights without spurious alignments.
- Downstream task performance: embeddings achieve non-trivial accuracy on compound identification or spectra clustering benchmarks (e.g., GNPS dataset).
Limitations
- Requires normalized peak m/z and intensity inputs; raw, unnormalized spectra will produce out-of-range embeddings. Preprocessing via cal_tanimoto_score.ipynb or dataset_preprocessing.ipynb is necessary.
- Performance depends on choice of frequency scales and embedding dimensionality; no guidance is provided in the article for tuning these hyperparameters beyond transformer defaults.
- Does not account for complex peak features such as isotope patterns or neutral loss metadata unless explicitly augmented into the metadata array.
- Sinusoidal encoding assumes relative peak positions are meaningful; spectra that have been heavily filtered or deisotoped may lose information.
Evidence
- [intro] peak_encoding: "Define the sinusoidal embedding function that encodes peak m/z and intensity values using sine and cosine basis functions at multiple frequency scales."
- [intro] embedder_module: "Implement the embedder module as a callable component that accepts peak metadata (m/z array, intensity array) and outputs fixed-length tensor representations compatible with Transformer input."
- [intro] validation_criteria: "Validate embedding output shape, numerical range, and orthogonality properties of the sinusoidal encoding."
- [intro] unit_tests: "Create unit tests confirming embedder handles variable-length peak lists, normalizes inputs correctly, and produces deterministic outputs."
- [readme] clerms_architecture: "The model architecture equipped with a sinusoidal embedder and a novel loss function composed of InfoNCE loss and MSE loss has been proposed for the obtaining of good embedding from the peak"
- [readme] preprocessing_requirement: "Some of the records in the spectra data contain inaccurate data or some of the information is missing. So, we remove them from the input data. Also, the peak information needs to be normalized for"
1---2name: sinusoidal-positional-encoding-design-23description: Use when you have variable-length lists of MS/MS peaks (m/z and intensity pairs) that need to be encoded into a fixed-dimensional representation compatible with transformer architecture.4license: CC-BY-4.05---67# sinusoidal-positional-encoding-design89> **License: restricted** — no clear open-source license detected for the underlying tool; verify licensing before commercial use or redistribution. <!-- asb-license-banner -->10## Summary1112Design and implement a sinusoidal embedder that encodes MS/MS peak m/z and intensity metadata into fixed-length tensor representations for transformer input. This skill is essential when building transformer-based models for mass spectrometry data where peak positions and magnitudes must be converted into learnable token embeddings.1314## When to use1516You have variable-length lists of MS/MS peaks (m/z and intensity pairs) that need to be encoded into a fixed-dimensional representation compatible with transformer architecture. Use this skill when your downstream model requires position-aware and magnitude-aware embeddings of mass spectrometry spectral data, and when contrastive learning or attention mechanisms depend on structured peak metadata.1718## When NOT to use1920- Peak data is already pre-embedded or represents a feature table incompatible with sinusoidal encoding.21- Your model does not use transformer architecture or does not require position-aware embeddings.22- MS/MS data has been heavily binned or discretized into fixed-size histogram bins (use existing bin indices instead).2324## Inputs2526- m/z array (mass-to-charge ratio values, typically numpy array or tensor)27- intensity array (peak intensity values, aligned with m/z array)28- peak metadata (optional: retention time, adduct type, or other spectral properties)29- variable-length peak lists (ragged or padded)3031## Outputs3233- fixed-length tensor embeddings compatible with transformer input34- embedding tensor of shape (batch_size, max_peaks, embedding_dim)35- normalized embeddings with documented numerical range3637## How to apply3839Define sinusoidal basis functions at multiple frequency scales to encode peak m/z and intensity values independently, following the standard transformer positional encoding pattern. Normalize input peak m/z and intensity arrays to consistent ranges (typically [0, 1] or standardized). Implement the embedder as a callable module that accepts raw peak metadata and outputs fixed-length tensors. Validate that embeddings have the correct shape, numerical range within expected bounds, and exhibit orthogonality properties across frequency dimensions. Handle variable-length peak lists through padding or masking, and confirm deterministic output for identical inputs.4041## Related tools4243- **PyTorch** (Tensor computation and neural module implementation for the sinusoidal embedder)44- **matchms** (MS/MS spectrum object handling and peak metadata extraction)45- **CLERMS** (Reference implementation of sinusoidal embedder integrated with contrastive learning and transformer backbone) — github.com/HaldamirS/CLERMS4647## Examples4849```50python model.ipynb # After running dataset_preprocessing.ipynb and cal_tanimoto_score.ipynb to normalize peaks; embedder processes m/z and intensity arrays into fixed-length tensors for CLERMS transformer training.51```5253## Evaluation signals5455- Embedding tensor shape matches (batch_size, num_peaks, embedding_dim) with no ragged dimensions.56- Numerical values lie within expected range (e.g., ±1.0 for standard sinusoidal encoding) and do not contain NaN or Inf.57- Orthogonality check: dot product between embedding vectors from different frequency scales is near zero.58- Determinism: identical peak lists produce identical embeddings across repeated runs.59- Variable-length handling: padded or masked embeddings produce valid transformer attention weights without spurious alignments.60- Downstream task performance: embeddings achieve non-trivial accuracy on compound identification or spectra clustering benchmarks (e.g., GNPS dataset).6162## Limitations6364- Requires normalized peak m/z and intensity inputs; raw, unnormalized spectra will produce out-of-range embeddings. Preprocessing via cal_tanimoto_score.ipynb or dataset_preprocessing.ipynb is necessary.65- Performance depends on choice of frequency scales and embedding dimensionality; no guidance is provided in the article for tuning these hyperparameters beyond transformer defaults.66- Does not account for complex peak features such as isotope patterns or neutral loss metadata unless explicitly augmented into the metadata array.67- Sinusoidal encoding assumes relative peak positions are meaningful; spectra that have been heavily filtered or deisotoped may lose information.6869## Evidence7071- [intro] peak_encoding: "Define the sinusoidal embedding function that encodes peak m/z and intensity values using sine and cosine basis functions at multiple frequency scales."72- [intro] embedder_module: "Implement the embedder module as a callable component that accepts peak metadata (m/z array, intensity array) and outputs fixed-length tensor representations compatible with Transformer input."73- [intro] validation_criteria: "Validate embedding output shape, numerical range, and orthogonality properties of the sinusoidal encoding."74- [intro] unit_tests: "Create unit tests confirming embedder handles variable-length peak lists, normalizes inputs correctly, and produces deterministic outputs."75- [readme] clerms_architecture: "The model architecture equipped with a sinusoidal embedder and a novel loss function composed of InfoNCE loss and MSE loss has been proposed for the obtaining of good embedding from the peak"76- [readme] preprocessing_requirement: "Some of the records in the spectra data contain inaccurate data or some of the information is missing. So, we remove them from the input data. Also, the peak information needs to be normalized for"
HolobiomicsLab