class_docstr: Compute the Pan Matrix Profile with a distributed dask/ray cluster
  
  This is based on the SKIMP algorithm.
  
  Parameters
  ----------
  client : client
      A Dask or Ray Distributed client. Setting up a distributed cluster is beyond
      the scope of this library. Please refer to the Dask or Ray Distributed
      documentation.
  
  T : numpy.ndarray
      The time series or sequence for which to compute the pan matrix profile
  
  min_m : int, default 3
      The starting (or minimum) subsequence window size for which a matrix profile
      may be computed
  
  max_m : int, default None
      The stopping (or maximum) subsequence window size for which a matrix profile
      may be computed. When `max_m = Non`, this is set to the maximum allowable
      subsequence window size
  
  step : int, default 1
      The step between subsequence window sizes
  
  normalize : bool, default True
      When set to `True`, this z-normalizes subsequences prior to computing distances.
      Otherwise, this function gets re-routed to its complementary non-normalized
      equivalent set in the `@core.non_normalized` function decorator.
  
  p : float, default 2.0
      The p-norm to apply for computing the Minkowski distance. This parameter is
      ignored when `normalize == True`.
  
  T_subseq_isconstant_func : function, default None
          A custom, user-defined function that returns a boolean array that indicates
          whether a subsequence in `T` is constant (True). The function must only take
          two arguments, `a`, a 1-D array, and `w`, the window size, while additional
          arguments may be specified by currying the user-defined function using
          `functools.partial`. Any subsequence with at least one np.nan/np.inf will
          automatically have its corresponding value set to False in this boolean
          array.
  
  Attributes
  ----------
  PAN_ : numpy.ndarray
      The transformed (i.e., normalized, contrasted, binarized, and repeated)
      pan matrix profile
  
  M_ : numpy.ndarray
      The full list of (breadth first search (level) ordered) subsequence window
      sizes
  
  Methods
  -------
  update():
      Compute the next matrix profile using the next available (breadth-first-search
      (level) ordered) subsequence window size and update the pan matrix profile
  
  See Also
  --------
  stumpy.stimp : Compute the Pan Matrix Profile
  stumpy.gpu_stimp : Compute the Pan Matrix Profile with with one or more GPU devices
  
  Notes
  -----
  `DOI: 10.1109/ICBK.2019.00031     <https://www.cs.ucr.edu/~eamonn/PAN_SKIMP%20%28Matrix%20Profile%20XX%29.pdf>`__
  
  See Table 2
  
  Examples
  --------
  >>> import stumpy
  >>> import numpy as np
  >>> from dask.distributed import Client
  >>> if __name__ == "__main__":
  ...     with Client() as dask_client:
  ...         pmp = stumpy.stimped(
  ...             dask_client,
  ...             np.array([584., -11., 23., 79., 1001., 0., -19.]))
  ...         pmp.update()
  ...         pmp.PAN_
  array([[0., 1., 1., 1., 1., 1., 1.],
         [0., 1., 1., 1., 1., 1., 1.]])
class_docstr_tok: ["Compute","the","Pan","Matrix","Profile","with","a","distributed","dask\/ray","cluster","This","is","based","on","the","SKIMP","algorithm",".","Parameters","--","--","--","--","--","client",":","client","A","Dask","or","Ray","Distributed","client",".","Setting","up","a","distributed","cluster","is","beyond","the","scope","of","this","library",".","Please","refer","to","the","Dask","or","Ray","Distributed","documentation",".","T",":","numpy.ndarray","The","time","series","or","sequence","for","which","to","compute","the","pan","matrix","profile","min_m",":","int",",","default","3","The","starting","(","or","minimum",")","subsequence","window","size","for","which","a","matrix","profile","may","be","computed","max_m",":","int",",","default","None","The","stopping","(","or","maximum",")","subsequence","window","size","for","which","a","matrix","profile","may","be","computed",".","When","`","max_m","=","Non","`",",","this","is","set","to","the","maximum","allowable","subsequence","window","size","step",":","int",",","default","1","The","step","between","subsequence","window","sizes","normalize",":","bool",",","default","True","When","set","to","`","True","`",",","this","z-normalizes","subsequences","prior","to","computing","distances",".","Otherwise",",","this","function","gets","re-routed","to","its","complementary","non-normalized","equivalent","set","in","the","`","@","core.non_normalized","`","function","decorator",".","p",":","float",",","default","2.0","The","p-norm","to","apply","for","computing","the","Minkowski","distance",".","This","parameter","is","ignored","when","`","normalize","==","True","`",".","T_subseq_isconstant_func",":","function",",","default","None","A","custom",",","user-defined","function","that","returns","a","boolean","array","that","indicates","whether","a","subsequence","in","`","T","`","is","constant","(","True",")",".","The","function","must","only","take","two","arguments",",","`","a","`",",","a","1-D","array",",","and","`","w","`",",","the","window","size",",","while","additional","arguments","may","be","specified","by","currying","the","user-defined","function","using","`","functools.partial","`",".","Any","subsequence","with","at","least","one","np.nan\/np.inf","will","automatically","have","its","corresponding","value","set","to","False","in","this","boolean","array",".","Attributes","--","--","--","--","--","PAN_",":","numpy.ndarray","The","transformed","(","i.e.",",","normalized",",","contrasted",",","binarized",",","and","repeated",")","pan","matrix","profile","M_",":","numpy.ndarray","The","full","list","of","(","breadth","first","search","(","level",")","ordered",")","subsequence","window","sizes","Methods","--","--","--","-","update","(",")",":","Compute","the","next","matrix","profile","using","the","next","available","(","breadth-first-search","(","level",")","ordered",")","subsequence","window","size","and","update","the","pan","matrix","profile","See","Also","--","--","--","--","stumpy.stimp",":","Compute","the","Pan","Matrix","Profile","stumpy.gpu_stimp",":","Compute","the","Pan","Matrix","Profile","with","with","one","or","more","GPU","devices","Notes","--","--","-","`","DOI",":","10.1109\/ICBK.2019.00031","<","https",":","\/\/www.cs.ucr.edu\/~eamonn\/PAN_SKIMP","%","20","%","28Matrix","%","20Profile","%","20XX","%","29.pdf",">","`","__","See","Table","2","Examples","--","--","--","--",">",">",">","import","stumpy",">",">",">","import","numpy","as","np",">",">",">","from","dask.distributed","import","Client",">",">",">","if","__name__","==","``","__main__","''",":","...","with","Client","(",")","as","dask_client",":","...","pmp","=","stumpy.stimped","(","...","dask_client",",","...","np.array","(","[","584.",",","-11.",",","23.",",","79.",",","1001.",",","0.",",","-19",".","]",")",")","...","pmp.update","(",")","...","pmp.PAN_","array","(","[","[","0.",",","1.",",","1.",",","1.",",","1.",",","1.",",","1",".","]",",","[","0.",",","1.",",","1.",",","1.",",","1.",",","1.",",","1",".","]","]",")"]
docstr: Initialize the `stimp` object and compute the Pan Matrix Profile
  
  Parameters
  ----------
  client : client
      A Dask or Ray Distributed client. Setting up a distributed cluster is beyond
      the scope of this library. Please refer to the Dask or Ray Distributed
      documentation.
  
  T : numpy.ndarray
      The time series or sequence for which to compute the pan matrix profile
  
  min_m : int, default 3
      The minimum subsequence window size to consider computing a matrix profile
      for
  
  max_m : int, default None
      The maximum subsequence window size to consider computing a matrix profile
      for. When `max_m = None`, this is set to the maximum allowable subsequence
      window size
  
  step : int, default 1
      The step between subsequence window sizes
  
  normalize : bool, default True
      When set to `True`, this z-normalizes subsequences prior to computing
      distances. Otherwise, this function gets re-routed to its complementary
      non-normalized equivalent set in the `@core.non_normalized` function
      decorator.
  
  p : float, default 2.0
      The p-norm to apply for computing the Minkowski distance. This parameter is
      ignored when `normalize == True`.
  
  T_subseq_isconstant_func : function, default None
      A custom, user-defined function that returns a boolean array that indicates
      whether a subsequence in `T` is constant (True). The function must only take
      two arguments, `a`, a 1-D array, and `w`, the window size, while additional
      arguments may be specified by currying the user-defined function using
      `functools.partial`. Any subsequence with at least one np.nan/np.inf will
      automatically have its corresponding value set to False in this boolean
      array.
docstr_tok: ["Initialize","the","`","stimp","`","object","and","compute","the","Pan","Matrix","Profile","Parameters","--","--","--","--","--","client",":","client","A","Dask","or","Ray","Distributed","client",".","Setting","up","a","distributed","cluster","is","beyond","the","scope","of","this","library",".","Please","refer","to","the","Dask","or","Ray","Distributed","documentation",".","T",":","numpy.ndarray","The","time","series","or","sequence","for","which","to","compute","the","pan","matrix","profile","min_m",":","int",",","default","3","The","minimum","subsequence","window","size","to","consider","computing","a","matrix","profile","for","max_m",":","int",",","default","None","The","maximum","subsequence","window","size","to","consider","computing","a","matrix","profile","for",".","When","`","max_m","=","None","`",",","this","is","set","to","the","maximum","allowable","subsequence","window","size","step",":","int",",","default","1","The","step","between","subsequence","window","sizes","normalize",":","bool",",","default","True","When","set","to","`","True","`",",","this","z-normalizes","subsequences","prior","to","computing","distances",".","Otherwise",",","this","function","gets","re-routed","to","its","complementary","non-normalized","equivalent","set","in","the","`","@","core.non_normalized","`","function","decorator",".","p",":","float",",","default","2.0","The","p-norm","to","apply","for","computing","the","Minkowski","distance",".","This","parameter","is","ignored","when","`","normalize","==","True","`",".","T_subseq_isconstant_func",":","function",",","default","None","A","custom",",","user-defined","function","that","returns","a","boolean","array","that","indicates","whether","a","subsequence","in","`","T","`","is","constant","(","True",")",".","The","function","must","only","take","two","arguments",",","`","a","`",",","a","1-D","array",",","and","`","w","`",",","the","window","size",",","while","additional","arguments","may","be","specified","by","currying","the","user-defined","function","using","`","functools.partial","`",".","Any","subsequence","with","at","least","one","np.nan\/np.inf","will","automatically","have","its","corresponding","value","set","to","False","in","this","boolean","array","."]
code: def __init__(
      self,
      client,
      T,
      min_m=3,
      max_m=None,
      step=1,
      normalize=True,
      p=2.0,
      T_subseq_isconstant_func=None,
  ):
      """
      Initialize the `stimp` object and compute the Pan Matrix Profile
  
      Parameters
      ----------
      client : client
          A Dask or Ray Distributed client. Setting up a distributed cluster is beyond
          the scope of this library. Please refer to the Dask or Ray Distributed
          documentation.
  
      T : numpy.ndarray
          The time series or sequence for which to compute the pan matrix profile
  
      min_m : int, default 3
          The minimum subsequence window size to consider computing a matrix profile
          for
  
      max_m : int, default None
          The maximum subsequence window size to consider computing a matrix profile
          for. When `max_m = None`, this is set to the maximum allowable subsequence
          window size
  
      step : int, default 1
          The step between subsequence window sizes
  
      normalize : bool, default True
          When set to `True`, this z-normalizes subsequences prior to computing
          distances. Otherwise, this function gets re-routed to its complementary
          non-normalized equivalent set in the `@core.non_normalized` function
          decorator.
  
      p : float, default 2.0
          The p-norm to apply for computing the Minkowski distance. This parameter is
          ignored when `normalize == True`.
  
      T_subseq_isconstant_func : function, default None
          A custom, user-defined function that returns a boolean array that indicates
          whether a subsequence in `T` is constant (True). The function must only take
          two arguments, `a`, a 1-D array, and `w`, the window size, while additional
          arguments may be specified by currying the user-defined function using
          `functools.partial`. Any subsequence with at least one np.nan/np.inf will
          automatically have its corresponding value set to False in this boolean
          array.
      """
      super().__init__(
          T,
          min_m=min_m,
          max_m=max_m,
          step=step,
          percentage=1.0,
          pre_scrump=False,
          client=client,
          mp_func=stumped,
          T_subseq_isconstant_func=T_subseq_isconstant_func,
      )
  
file_path: stumpy/stumpy/stimp.py
imports: import numpy
  from .None import core, scrump
  from .aamp_stimp import aamp_stimp, aamp_stimped
  from .stump import stump
  from .stumped import stumped
label_desc: Use image node_id 1 to create a new stimped object from inherited base classes: _stimp with example: obj = stimped(client, T, min_m, max_m, step, normalize, p, T_subseq_isconstant_func)