<commit_before>To install, navigate to this folder in Terminal and type:

pip install -e .

(this assumes you have pip installed on your system: https://pip.pypa.io/en/stable/installing/)

MAIN FUNCTIONS:

        hyp.plot - plots static data or movie
        hyp.align - hyperaligns multidimensional data
        hyp.reduce - implements PCA to reduce dimensionality of data
        hyp.describe - plots/analyses to evaluate how well the functions above are working

PLOT - 

INPUTS:

        X: a T by D matrix of observations.  T is the number of coordinates
        and D is the dimensionality of each observation.  NaNs are
        treated as missing observations.

ARGUMENTS:

        Format strings can be passed as a string, or tuple/list of length x.

        See matplotlib API for more styling options

KEYWORD ARGUMENTS:

        palette (string): A matplotlib or seaborn color palette

        color (list): A list of colors for each line to be plotted. Can be named colors, RGB values (e.g. (.3, .4, .1)) or hex codes. If defined, overrides palette. See http://matplotlib.org/examples/color/named_colors.html for list of named colors. Note: must be the same length as X.

        point_colors (list of str, floats or ints): A list of colors for each point. Must be dimensionality of data (X). If the data type is numerical, the values will be mapped to rgb values in the specified palette.  If the data type is strings, the points will be labeled categorically.

        linestyle (list): a list of line styles

        marker (list): a list of marker types

        See matplotlib API for more styling options

        labels (list): A list of labels for each point. Must be dimensionality of data (X). If no label is wanted for a particular point, input `None`

        explore (bool): (experimental feature) Displays user defined labels or PCA coordinates on hover. When a point is clicked, the label will remain on the plot (WIP). To use, set `explore=True`.
<commit_msg>update to readme<commit_after>To install, navigate to this folder in Terminal and type:

pip install -e .

(this assumes you have pip installed on your system: https://pip.pypa.io/en/stable/installing/)

MAIN FUNCTIONS:

        hyp.plot - plots static data or movie
        hyp.align - hyperaligns multidimensional data
        hyp.reduce - implements PCA to reduce dimensionality of data
        hyp.describe - plots/analyses to evaluate how well the functions above are working

<h2>PLOT</h2>

INPUTS:

        X: a T by D matrix of observations.  T is the number of coordinates
        and D is the dimensionality of each observation.  NaNs are
        treated as missing observations.

ARGUMENTS:

        Format strings can be passed as a string, or tuple/list of length x.

        See matplotlib API for more styling options

KEYWORD ARGUMENTS:

        palette (string): A matplotlib or seaborn color palette

        color (list): A list of colors for each line to be plotted. Can be named colors, RGB values (e.g. (.3, .4, .1)) or hex codes. If defined, overrides palette. See http://matplotlib.org/examples/color/named_colors.html for list of named colors. Note: must be the same length as X.

        point_colors (list of str, floats or ints): A list of colors for each point. Must be dimensionality of data (X). If the data type is numerical, the values will be mapped to rgb values in the specified palette.  If the data type is strings, the points will be labeled categorically.

        linestyle (list): a list of line styles

        marker (list): a list of marker types

        See matplotlib API for more styling options

        labels (list): A list of labels for each point. Must be dimensionality of data (X). If no label is wanted for a particular point, input `None`

        explore (bool): (experimental feature) Displays user defined labels or PCA coordinates on hover. When a point is clicked, the label will remain on the plot (WIP). To use, set `explore=True`.

{'fraction_non_alphanumeric': 0.05922208281053953, 'fraction_numerical': 0.0020075282308657464, 'mean_word_length': 2.9661691542288557, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '606980', 'n_tokens_mistral': 1094, 'n_tokens_neox': 1018, 'n_words': 574}