docstr: ivy.Container instance method variant of ivy.shuffle. This method
  simply wraps the function, and so the docstring for ivy.shuffle also
  applies to this method with minimal changes.
  
  Parameters
  ----------
  self
      Input container. Should have a numeric data type.
  axis
      The axis which input container is shuffled along. Default is 0.
  seed
      A python integer. Used to create a random seed distribution
  key_chains
      The key-chains to apply or not apply the method to. Default is ``None``.
  to_apply
      If True, the method will be applied to key_chains, otherwise key_chains
      will be skipped. Default is ``True``.
  prune_unapplied
      Whether to prune key_chains for which the function was not applied.
      Default is ``False``.
  map_sequences
      Whether to also map method to sequences (lists, tuples).
      Default is ``False``.
  out
      optional output container, for writing the result to. It must have a shape
      that the inputs broadcast to.
  
  Returns
  -------
  ret
      A container object, shuffled along the first dimension.
  
  Examples
  --------
  >>> x = ivy.Container(a=ivy.array([5, 2, 9]),
  ...                   b=ivy.array([7, 1, 6]))
  >>> y = ivy.Container.shuffle(x)
  >>> print(y)
  {
      a: ivy.array([9, 5, 2]),
      b: ivy.array([6, 7, 1])
  }
docstr_tok: ["ivy.Container","instance","method","variant","of","ivy.shuffle",".","This","method","simply","wraps","the","function",",","and","so","the","docstring","for","ivy.shuffle","also","applies","to","this","method","with","minimal","changes",".","Parameters","--","--","--","--","--","self","Input","container",".","Should","have","a","numeric","data","type",".","axis","The","axis","which","input","container","is","shuffled","along",".","Default","is","0.","seed","A","python","integer",".","Used","to","create","a","random","seed","distribution","key_chains","The","key-chains","to","apply","or","not","apply","the","method","to",".","Default","is","``","None","``",".","to_apply","If","True",",","the","method","will","be","applied","to","key_chains",",","otherwise","key_chains","will","be","skipped",".","Default","is","``","True","``",".","prune_unapplied","Whether","to","prune","key_chains","for","which","the","function","was","not","applied",".","Default","is","``","False","``",".","map_sequences","Whether","to","also","map","method","to","sequences","(","lists",",","tuples",")",".","Default","is","``","False","``",".","out","optional","output","container",",","for","writing","the","result","to",".","It","must","have","a","shape","that","the","inputs","broadcast","to",".","Returns","--","--","--","-","ret","A","container","object",",","shuffled","along","the","first","dimension",".","Examples","--","--","--","--",">",">",">","x","=","ivy.Container","(","a=ivy.array","(","[","5",",","2",",","9","]",")",",","...","b=ivy.array","(","[","7",",","1",",","6","]",")",")",">",">",">","y","=","ivy.Container.shuffle","(","x",")",">",">",">","print","(","y",")","{","a",":","ivy.array","(","[","9",",","5",",","2","]",")",",","b",":","ivy.array","(","[","6",",","7",",","1","]",")","}"]
code: def shuffle(
      self: ivy.Container,
      axis: Optional[Union[int, ivy.Container]] = 0,
      /,
      *,
      seed: Optional[Union[int, ivy.Container]] = None,
      key_chains: Optional[
          Union[List[str], Dict[str, str], ivy.Container]
      ] = None,
      to_apply: Union[bool, ivy.Container] = True,
      prune_unapplied: Union[bool, ivy.Container] = False,
      map_sequences: Union[bool, ivy.Container] = False,
      out: Optional[ivy.Container] = None,
  ) -> ivy.Container:
      """ivy.Container instance method variant of ivy.shuffle. This method
      simply wraps the function, and so the docstring for ivy.shuffle also
      applies to this method with minimal changes.
  
      Parameters
      ----------
      self
          Input container. Should have a numeric data type.
      axis
          The axis which input container is shuffled along. Default is 0.
      seed
          A python integer. Used to create a random seed distribution
      key_chains
          The key-chains to apply or not apply the method to. Default is ``None``.
      to_apply
          If True, the method will be applied to key_chains, otherwise key_chains
          will be skipped. Default is ``True``.
      prune_unapplied
          Whether to prune key_chains for which the function was not applied.
          Default is ``False``.
      map_sequences
          Whether to also map method to sequences (lists, tuples).
          Default is ``False``.
      out
          optional output container, for writing the result to. It must have a shape
          that the inputs broadcast to.
  
      Returns
      -------
      ret
          A container object, shuffled along the first dimension.
  
      Examples
      --------
      >>> x = ivy.Container(a=ivy.array([5, 2, 9]),
      ...                   b=ivy.array([7, 1, 6]))
      >>> y = ivy.Container.shuffle(x)
      >>> print(y)
      {
          a: ivy.array([9, 5, 2]),
          b: ivy.array([6, 7, 1])
      }
      """
      return self._static_shuffle(
          self,
          axis,
          seed=seed,
          key_chains=key_chains,
          to_apply=to_apply,
          prune_unapplied=prune_unapplied,
          map_sequences=map_sequences,
          out=out,
      )
  
file_path: ivy/ivy/data_classes/container/random.py
imports: from typing import Optional, Union, List, Dict
  import ivy
  from ivy.data_classes.container.base import ContainerBase
label_desc: Use image node_id 10 for calling the _ContainerWithRandom obj's underlying member method code with example usage: obj.shuffle() and returns: self