Skip to content

Latest commit

 

History

History
293 lines (216 loc) · 9.57 KB

CHANGELOG.md

File metadata and controls

293 lines (216 loc) · 9.57 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.5.3

Fixed

  • Updated the doi to the MS2Query library. This new library has a fix for a bug misrepresenting the compound classes.

1.5.2

Fixed

  • Handle missing compound names. Previously MS2Query would break, when no compound name was available for an analog.
  • Fix bug for creating sqlite files. Missing compound class annotations would be stored incorrectly. The creation now works correctly, but the download link to the models, still points to the sqlite files with mistakes. MS2Query can be used, but this leads to weird formatting in the results file of the class annotations.

1.5.1

Fixed

  • Set max matchms version, since breaking change was introduced (missing add_losses)
  • Set max scipy version, since breaking change was introduced (for windows)

1.5.0

Changed

  • MS2Query is now tested on python 3.9 and 3.10 instead of 3.8 and 3.9
  • MS2Query is using MS2Deepscore 2.0. This is a breaking change, making MS2Query not work with old models anymore
  • Updated model to use MS2Deepscore 2.0 and used newly available training data for all models.

1.4.0

Changed

  • Made compatible with MS2Deepscore 0.5.0

1.3.0

Changed

  • New models have to be downloaded, since this version is not compatible with the older models! Embeddings have to be stored as parquet.
  • Embeddings are now stored by parquet instead of pickle
  • Made MS2Query compatible with matchms 0.24.0

1.2.4

Added

  • environment.yml and CI_build test fur building a conda env from this file

fixed

  • Allow for using uper_case additional_metadata columns
  • Removed pickled files from tests to pave way to pandas 2.0 and new matchms

1.2.2

fixed

  • Set version of matchmsextras to 0.4.0, to fix dependency issue
  • Fix test with wrong sklearn version.

Changed

  • Set default additional metadata from rtinseconds to retention_time

1.2.1

fixed

  • Fix bug in downloading models from command line

1.2.0

Changed

  • Made compatible with matchms => 0.14

Added

  • Added separate workflow for integration tests
  • Changed automatic publish python branch used

[1.1.0]

Removed

  • Option to return results table.

Added

  • Option to return dataframe with results.

[1.0.1]

Small bug fixes

  • Allow URLLiberror when loading in compound classes
  • Update readme with zenodo files

[1.0.0]

Added

  • Added compound classes to sqlite file
  • Compound classes are now automatically added in the library file creation pipeline.
  • Smiles are added from the specific spectrum instead of from the inchikey.

Removed

  • Compound classes cannot be added from csv file anymore. Download the newest version of the sqlite file to have compoudn classes again.

Changed

  • Zenodo link is set to latest version instead of specific version.

Code structure

  • Unit tests had mayor reformatting
    • Better use of global fixtures
    • Remove pickled results table files

[0.7.4]

  • Set MS2Deepscore <2.0.0

[0.7.3]

  • Fix h5py dependency issue

[0.7.2]

  • Downloading files is more modular.
  • Loading only the models for training your own model is easier.
  • The default settings for additional metadata are changed to match mgf files from feature based molecular networking
  • Readme has been cleaned up

[0.7.1]

  • Define the newest zenodo DOI in one location.

[0.7.0]

  • Store random forest model in Onnx format

[0.6.6]

  • Added --addional_metadat to command line usage

[0.6.5]

  • Fix dependency issue on matchmsextras

Added

  • Make command line runnable
  • Add explanation for running from command line to readme
  • Check if the ionization mode of query spectra is the same as the library
  • Added option to automatically split library on ionization mode.

Changed

  • When output file already exists a new file is created like output_file(1).csv
  • Remove warning tensorflow
  • Set tensorflow to <2.9 to prevent printing of progress bars for ms2deepscore
  • Set scikit learn to version 0.24.2 to prevent risk of backwards compatibility issues.

Changed

  • Finalize workflow for k-fold cross validation
  • Add explanation for reproducing results to readme

Changed

  • Set tensorflow version to <= 2.10.1

[0.5.5]

Changed

  • Set tensorflow version to <= 2.4.1

Changed

  • Set tensorflow version to <= 2.10.1

Changed

  • Remove tensorflow warnings about feature names

Changed

  • Remove rdkit dependency for running MS2Query

Added

  • Training models is now fully automatic (no need for notebooks)
  • Functions for creating benchmarking results
  • Functions for doing k_fold_cross_validation
  • Functions for visualizing benchmarking results

Changed

  • Method for creating new library files
  • Cleaning spectra functions for running are now combined with cleaning spectra functions for training
  • Do not store MS2Deepscores in results table, to prevent memory issues
  • Changed calculation of tanimoto scores, for better memory efficiency
    • Code structure changed, tanimoto scores are now calculated in create_sqlite_database, instead of library_files_creator.

Removed

  • Option to use previously calculated tanimoto scores as input for creating the sqlite library

Changed

  • Creating your own library files for ms2query is a lot easier (see readme)
  • Downloading negative mode files is added
  • Downloading from zenodo is more robust

Changed

  • Use smaller SQlite file. Tanimoto scores and peak and intensities are not stored anymore reducing the sqlite file size to 300 mb
  • Generate spectrum id integers, instead of using spectrum id specified in the metadata of spectra.

Added

  • Updated notebooks for performance analysis
  • Solved bug in downloading library

Changed

  • Made handling different pandas versions more flexible

Changed

  • change numbering of spectra #135
  • updated zenodo link to new updated files #133

Added

  • Switch to random forest model
  • Changed input features for random forest model #130
  • retention_index and retention_time are cleaned by matchms in data filtering #127

Changed

  • switched to newer matchms (>=0.11.0) and spec2vec (>=0.6.0) versions #127
  • Changed names for features random forest model

Removed

  • Remove neural network model functionality
  • Remove multiple chemical neighbourhood related scores

0.2.4 - 2021-04-11

  • Solved bug in downloading Zenodo files

0.2.3 - 2021-02-11

  • Added run_ms2query to make it more user friendly
  • Refactored code to process spectrum per spectrum instead of list of spectra

0.2.2 - 2021-09-30

  • Refactored code to use results table
  • Made compatible with newer pandas and gensim versions

0.2.1 - 2021-06-14

Changed

  • Changed release workflow, so pip package is also updated.

0.2.0 - 2021-06-14

Added

  • Move library parts to Sqlite #56
  • Define spectrum processing functions #61
  • Extend CI workflow and add Sonarcloud #62
  • Average inchikey score and neighbourhood score #78

Removed

  • Streamlit web app (will now be future development) #83

Changed

  • Refactored library matching #65
  • Split workflow into true matches and analog search #72
  • Refactored library files creation #74

Fixed

0.1.0 - 2021-01-01

Added

  • First ms2query prototype sketching the basic workflow and a streamlit web app.
  • First test workflow and basic batches.
  • Licence.