annotate spec2vec_similarity.xml @ 0:881742fff7ff draft default tip

planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
author recetox
date Tue, 27 Jun 2023 14:23:58 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
1 <tool id="spec2vec_similarity" name="spec2vec similarity" version="@TOOL_VERSION@+galaxy0" profile="21.09">
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
2 <macros>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
3 <import>macros.xml</import>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
4 </macros>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
5 <expand macro="creator"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
6 <expand macro="edam" />
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
7
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
8 <requirements>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">spec2vec</requirement>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
10 </requirements>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
11
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
12 <command detect_errors="aggressive"><![CDATA[
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
13 python3 ${python_wrapper}
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
14 ]]></command>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
15 <configfiles>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
16 <configfile name="python_wrapper">
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
17 @init_logger@
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
18 @init_model@
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
19
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
20 import numpy as np
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
21 from spec2vec import Spec2Vec
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
22
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
23 similarity = Spec2Vec(
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
24 model,
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
25 intensity_weighting_power=${intensity_power},
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
26 allowed_missing_percentage=${allow_missing_percentage} * 100
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
27 )
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
28 name="Spec2Vec_${intensity_power}_${allow_missing_percentage}"
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
29
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
30 @init_scores@
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
31
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
32 from matchms.filtering import normalize_intensities
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
33
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
34 layer = similarity.sparse_array(
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
35 references=np.asarray(list(map(normalize_intensities, scores.references))),
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
36 queries=np.asarray(list(map(normalize_intensities, scores.queries))),
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
37 idx_row = scores._scores.row,
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
38 idx_col = scores._scores.col,
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
39 is_symmetric=False)
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
40
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
41 scores._scores.add_sparse_data(scores._scores.row, scores._scores.col, layer, name)
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
42
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
43 scores.filter_by_range(inplace=True, name=name, low=0)
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
44 scores.to_json("$similarity_scores")
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
45 </configfile>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
46 </configfiles>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
47
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
48 <inputs>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
49 <expand macro="input_param" />
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
50 <param label="Model JSON file" name="model_metadata" type="data" format="json"
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
51 help="Model JSON file to use for Spec2Vec similarity computing."/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
52 <param label="Model NPY file" name="model_weights" type="data" format="binary"
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
53 help="Model NPY file to use for Spec2Vec similarity computing."/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
54 <param label="intensity_power" name="intensity_power" type="float" value="0.0"
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
55 help="Spectrum vectors are a weighted sum of the word vectors. The given word intensities will be raised to the given power.
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
56 The default is 0, which means that no weighing will be done."/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
57 <param label="Maximum share of new peaks" name="allow_missing_percentage" type="float" value="0.1" max="1.0" min="0.0"
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
58 help="Maximum allowed share of the peaks that are new to the model in relation to the whole peak corpus."/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
59 </inputs>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
60 <outputs>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
61 <data label="Spec2Vec scores of ${on_string}" name="similarity_scores" format="json"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
62 </outputs>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
63
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
64 <tests>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
65 <test> <!-- TEST #1: Test Spec2Vec. -->
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
66 <param name="references" value="inp_filtered_library.msp" ftype="msp"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
67 <param name="queries" value="inp_filtered_spectra.msp" ftype="msp"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
68 <param name="model_metadata" value="model_100.json" ftype="json"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
69 <param name="model_weights" value="weights_100.binary" ftype="auto"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
70 <param name="allow_missing_percentage" value="1.0"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
71 <output name="similarity_scores" file="s2v_scores_test1_out.json" ftype="json"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
72 </test>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
73 <test>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
74 <param name="use_scores" value="True"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
75 <param name="scores_in" value="ri_match_60.json" ftype="json"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
76 <param name="model_metadata" value="model_100.json" ftype="json"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
77 <param name="model_weights" value="weights_100.binary" ftype="auto"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
78 <param name="allow_missing_percentage" value="1.0"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
79 <output name="similarity_scores" value="s2v_scores_test2_out.json" ftype="json" />
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
80 </test>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
81 </tests>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
82
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
83 <expand macro="citations"/>
881742fff7ff planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/spec2vec commit f79a5b51599254817727bc9028b9797ea994cb4e
recetox
parents:
diff changeset
84 </tool>