Package: seeq-mps
Multivariate Pattern Search [MPS]is a Seeq Add-on for multivariate search and similarity assessment. This Add-on
supports both continuous and batch processes. In continuous mode, the Add-on finds multivariate profiles in time that
are similar to a visually captured reference.
In batch mode, the Add-on computes a multivariate similarity score per batch that allows the user to identify batches that
are similar or dissimilar to a prespecified â€˜goldenâ€™ reference set ('golden batches'). Additionally, MPS also provides a contribution score
for each signal. This allows the user to determine which signals contributed to the observed similarity or dissimilarity
and utilize that information for accelerated diagnostics/troubleshooting.DocumentationDocumentation forseeq-mps.User Guideseeq-MPS User Guideprovides an in-depth explanation of reference search, batch analysis and how seeq-mps works. Examples of typical
analyses usingseeq-mpscan be found in the
sectionUse Cases.The video below is a short demonstration of the MPS add-onhttps://user-images.githubusercontent.com/5995501/156315178-a55b7a52-4ea5-46cb-8f52-d3f7d7998ab8.mp4InstallationThe backend ofseeq-mpsrequiresPython 3.7or later.DependenciesSeerequirements.txtfile for a list of
dependencies and versions. Additionally, you will need to install theseeqmodule with the appropriate version that
matches your Seeq server. For more information on theseeqmodule seeseeq at pypiUser Installation Requirements (Seeq Data Lab)If you want to installseeq-mpsas a Seeq Add-on, you will need:Seeq Data Lab (>=53.0.0 or >=R54.0.2)seeqmodule whose version matches the Seeq server versionSeeq administrator accessEnable Add-on in the Seeq serverUser Installation (Seeq Data Lab)The latest build of the project can be foundhereas a wheel file. The file is published as a
courtesy and does not imply any guarantee or obligation for support from the publisher.Create anewSeeq Data Lab project and open theTerminalwindowRunpip install seeq-mpsRunpython -m seeq.addons.mpsFollow the instructions when prompted. ("Username or Access Key" is what you use to log in to Seeq. "Password" is your
password for logging into Seeq.)There are additionalOptionsfor the addon installation. These include--usersand--groups. These can be used
to change permissions for the addon tool. For example to give permission to usersmeandyouone would install the
addon with as:python-mseeq.addons.mps--usersmeyouDevelopmentWe welcome new contributors of all experience levels. TheDevelopment Guidehas detailed information about
contributing code, documentation, tests, etc.Important linksOfficial source code repo:https://github.com/seeq12/seeq-mpsIssue tracker:https://github.com/seeq12/seeq-mps/issuesSource codeYou can get started by cloning the repository with the command:gitclonegit@github.com:seeq12/seeq-mps.gitInstallation from sourceFor development work, it is highly recommended creating a python virtual environment and install the package in that
working environment. If you are not familiar with python virtual environments, you can take a
lookhereOnce your virtual environment is activated, you can install requirements andseeq-mpsfrom source with:pipinstall-rrequirements.txt
pythonsetup.pyinstallTroubleshootingIf you experience the following error:Exception: The compiled dtaidistance C library is not available. See the documentation for alternative installation
options.It could be from a known issue from the packagedtaidistanceand C library availability, please follow their
guide for troubleshooting:https://dtaidistance.readthedocs.io/en/latest/usage/installation.htmlTestingThere are several types of testing available forseeq-mpsAutomatic TestingAfter installation, you can launch the test suite from thetestsfolder in the root directory of the project. You will
need to have pytest >= 4.3.1 installed.To run all tests:pytestUser Interface TestingTo test the UI, use thedeveloper_notebook.ipynbin thedevelopmentfolder of the project. This notebook can also be
used while debugging from your IDE.ChangelogThe changelog can be foundhereSupportCode related issues (e.g. bugs, feature requests) can be created in theissue trackerMaintainer: James HiggieCitationPlease cite this work as:seeq-mps
SeeqCorporation,2021https://github.com/seeq12/seeq-mps