dsadd4 commited on
Commit
a4d78ac
·
verified ·
1 Parent(s): ab2e6ff

Simplify model usage guide

Browse files
Files changed (1) hide show
  1. README.md +16 -8
README.md CHANGED
@@ -6,13 +6,21 @@ tags:
6
  - spectrum-embedding
7
  ---
8
 
9
- # UltraMS RT-only
10
 
11
- UltraMS spectrum encoder after pretraining and RT/ion-mode adaptation. Use it to obtain a general representation of an MS/MS spectrum.
12
 
13
- - **Input:** fragment `m/z` and intensity arrays, plus precursor `m/z`.
14
- - **Output:** a spectrum embedding (`embedding.embedding`); the `ultrams` package also exposes CLS, peak-weighted, and fused embeddings.
15
- - **Load:** `pip install "ultrams[hub]"`; `UltraMS.from_hub("dsadd4/UltraMS-RT-only")`.
16
- - **Source checkpoint:** `Light_ultra/train/output/phase2_rt_only/stage_d_epoch_11.pt`.
17
- - **Expected source SHA256:** `6a4c6660999848c409303119f6caa54fbae9444d0b75c7fcd8bafd303cde9830`.
18
- - **License:** Apache-2.0.
 
 
 
 
 
 
 
 
 
6
  - spectrum-embedding
7
  ---
8
 
9
+ # UltraMS Unsupervised
10
 
11
+ Use this model to obtain a general embedding of an MS/MS spectrum.
12
 
13
+ ```bash
14
+ pip install ultrams
15
+ ```
16
+
17
+ ```python
18
+ from ultrams import UltraMS
19
+
20
+ model = UltraMS.from_pretrained("unsupervised")
21
+ embedding = model.encode(
22
+ mz=[100.1, 121.1, 150.0], intensity=[20, 100, 35], precursor_mz=301.2
23
+ ).embedding
24
+ ```
25
+
26
+ Fine-tuning examples are in the [UltraMS repository](https://github.com/Dsadd4/UltraMS).