Data In H2O

A H2OFrame represents a 2D array of data where each column is uniformly typed.

The data may be local or it may be in an H2O cluster. The data are loaded from a CSV file or from a native Python data structure, and is either a Python client-relative file, a cluster-relative file, or a list of H2OVec objects.

Loading Data From A CSV File

Load data using either h2o.import_file or h2o.upload_file.

h2o.import_file uses cluster-relative names and ingests data in parallel.

h2o.upload_file uses Python client-relative names and single-threaded file upload from the client.

H2O’s parser supports data of various formats from multiple sources. The following formats are supported:

  • ARFF
  • CSV (data may delimited by any of the 128 ASCII characters)
  • SVMLight
  • XLS
  • XLSX

The following data sources are supported:

  • NFS / Local File / List of Files
  • HDFS
  • URL
  • A Directory (with many data files inside at the same level – no support for recursive import of data)
  • S3/S3N
  • Native Language Data Structure (c.f. the subsequent section)
>>> trainFrame = h2o.import_file(path="hdfs://192.168.1.10/user/data/data_test.csv")
#or
>>> trainFrame = h2o.import_file(path="~/data/data_test.csv")

Loading Data From A Python Object

To transfer the data that are stored in python data structures to H2O, use the H2OFrame constructor and the python_obj argument. Additionally, from_python performs the same function but provides a few more options for how H2O will parse the data.

The following types are permissible for python_obj:

  • tuple ()
  • list []
  • dict {}
  • collections.OrderedDict

The type of python_obj is inspected by performing an isinstance call. A ValueError will be raised if the type of python_obj is not one of the above types. For example, sets, byte arrays, and un-contained types are not permissible.

The subsequent sections discuss each data type in detail in terms of the “source” representation (the python object) and the “target” representation (the H2O object). Concretely, the topics of discussion will be on the following: Headers, Data Types, Number of Rows, Number of Columns, and Missing Values.

In the following documentation, H2OFrame and Frame will be used synonymously. Technically, an H2OFrame is the object-pointer that resides in the python VM and points to a Frame object inside of the H2O JVM. Similarly, H2OFrame, Frame, and H2O Frame all refer to the same kind of object. In general, though, the context is from the python VM, unless otherwise specified.

Loading A Python Tuple

Essentially, the tuple is an immutable list. This immutability does not map to the H2OFrame. So Pythonistas beware!

The restrictions on what goes inside the tuple are fairly relaxed, but if they are not recognized, a ValueError is raised.

A tuple is formatted as follows:

(i1, i2, i3, ..., iN)

Restrictions are mainly on the types of the individual iJ (1 <= J <= N). Here N is the number of rows in the column represented by this tuple.

If iJ is {} for some J, then a ValueError is raised. If iJ is a () (tuple) or [] (list), then iJ must be a () or [] for all J; otherwise a ValueError is raised. In other words, any mixing of types will result in a

Additionally, only a single layer of nesting is allowed: if iJ is a () or [], and if it contains any () or [], then a ValueError is raised.

If iJ is not a () or [], then it must be of type string or a non-complex numeric type (float or int). In other words, if iJ is not a tuple, list, string, float, or int, for some J, then a ValueError is raised.

Some examples of acceptable inputs are:
  • Example A: (1,2,3)
  • Example B: ((1,2,3), (4,5,6), (“cat”, “dog”))
  • Example C: ((1,2,3), [4,5,6], [“blue”, “yellow”], (321.239, “green”,”hi”))
  • Example D: (3284.123891, “dog”, 89)

Note that it is perfectly fine to mix () and [] within a tuple.

Headers, Columns, Rows, Data Types, and Missing Values:

The format of the H2OFrame is as follows:

column1 column2 column3 ... columnN
a11, a12, a13, ..., a1N
., ., ., ..., .
., ., ., ..., .
., ., ., ..., .
aM1, aM2, aM3, ..., aMN

It looks exactly like an MxN matrix with an additional header “row”. This header cannot be specified when loading data from a () (or from a [] but it is possible to specify a header with a python dictionary (see below for details).

Headers:

Since no header row can be specified for this case, H2O automatically generates a column header in the following format:

C1, C2, C3, ..., CN

Notably, these columns have a 1-based indexing (i.e. the 0th column is “C1”).

Rows, Columns, and Missing Data:

The shape of the H2OFrame is determined by two factors:

  • the number of arrays nested in the ()
  • the number of items in each array

If there are no nested arrays (as in Example A and Example D above), the resulting H2OFrame will have the following shape (rows x cols):

len(tuple) x 1

(i.e. a Frame with a single column).

If there are nested arrays (as in Example B and Example C above), then the resulting H2OFrame will have COLUMNS equal to the number of arrays nested within and ROWS equal to the maximum sub-array:

len(tuple) x max( [len(l) for l in tuple] )

Note that this addresses the issue with ragged sub-arrays by assuming that shorter sub-arrays will pad themselves with NA (missing values) at the end so that they become the correct length.

Because the Frame is uniformly typed, combining data types within a column may produce unexpected results. Please read up on the H2O parser for details on how a column type is determined for mixed-type columns. Also, as stated above, you may use the from_python method to provide a set of column types.

Loading A Python List

The same principles that apply to tuples also apply to lists. Lists are mutable objects, so there is no semantic difference regarding mutability between an H2OFrame and a list (as there is for a tuple).

Additionally, a list [] is ordered the same way as a tuple (), with the data appearing within the brackets.

Loading A Python Dictionary Or collections.OrderedDict

Each entry in the {} is expected to represent a single column. Keys in the {} must be character strings following the pattern: ^[a-zA-Z_][a-zA-Z0-9_.]*$ without restriction on length. A valid column name may begin with any letter (capital or not) or an “_”, followed by any number of letters, digits, “_”s, or ”.”s.

Values in the {} may be a flat [], a flat (), or a single int, float, or string value. Nested [] and () will raise a ValueError. This is the only additional restriction on [] and () that applies in this context.

Note that the built-in dict does not provide any guarantees on ordering. This has implications on the order of columns in the eventual H2OFrame, since they may be written out of order from which they were initially put into the dict.

collections.OrderedDict preserves the order of the key-value pairs in which they were entered.

H2OFrame

class h2o.frame.H2OFrame(python_obj=None)[source]

Bases: object

Attributes

col_names
columns
dim
frame_id
names
ncol
nrow
shape
types Define names for all type symbols known in the standard interpreter.

Methods

abs
acos
acosh
all
any
any_na_rm
anyfactor
apply
as_data_frame
as_date
ascharacter
asfactor
asin
asinh
asnumeric
atan
atanh
cbind
ceil
cos
cosh
cospi
countmatches
cummax
cummin
cumprod
cumsum
cut
day
dayOfWeek
ddply
describe
digamma
drop
exp
expm1
filter_na_cols
flatten
floor
from_python
gamma
get_frame
get_frame_data
group_by
gsub
head
hist
hour
ifelse
impute
insert_missing_values
interaction
is_src_in_self
ischaracter
isfactor
isin
isna
isnumeric
isstring
kfold_column
levels
lgamma
log
log10
log1p
log2
logical_negation
match
max
mean
median
merge
min
mktime
modulo_kfold_column
month
mult
na_omit
nacnt
nchar
nlevels
pop
prod
quantile
rbind
rep_len
round
runif
scale
sd
set_level
set_levels
set_name
set_names
show
sign
signif
sin
sinh
sinpi
split_frame
sqrt
stratified_kfold_column
stratified_split
strsplit
structure
sub
substring
sum
summary
table
tail
tan
tanh
tanpi
tolower
toupper
transpose
trigamma
trim
trunc
type
unique
var
week
which
year
abs()[source]
acos()[source]
acosh()[source]
all()[source]
Returns:True if every element is True or NA in the column.
any()[source]
Returns:True if any element is True or NA in the column.
any_na_rm()[source]
Returns:True if any element is True in the column.
anyfactor()[source]

Test if H2OFrame has any factor columns.

Returns:True if there are any categorical columns; False otherwise.
apply(fun=None, axis=0)[source]

Apply a lambda expression to an H2OFrame.

Parameters:

fun: lambda

A lambda expression to be applied per row or per column

axis: int

0: apply to each column; 1: apply to each row

Returns:

H2OFrame

as_data_frame(use_pandas=False)[source]

Obtain the dataset as a python-local object.

Parameters:

use_pandas : bool, default=False

A flag specifying whether or not to return a pandas DataFrame.

Returns:

A local python object (a list of lists of strings, each list is a row, if

use_pandas=False, otherwise a pandas DataFrame) containing this H2OFrame instance’s data.

as_date(format)[source]

Return the column with all elements converted to millis since the epoch.

Parameters:

format : str

A datetime format string (e.g. “YYYY-mm-dd”)

Returns:

An H2OFrame instance.

ascharacter()[source]

All columns converted to String columns

Returns:H2OFrame
asfactor()[source]
Returns:H2Oframe of one column converted to a factor.
asin()[source]
asinh()[source]
asnumeric()[source]

All factor columns converted to numeric.

Returns:H2OFrame
atan()[source]
atanh()[source]
cbind(data)[source]

Append data to this H2OFrame column-wise.

Parameters:

data : H2OFrame

H2OFrame to be column bound to the right of this H2OFrame.

Returns:

H2OFrame of the combined datasets.

ceil()[source]
col_names None[source]
Returns:A list of column names.
columns None[source]
Returns:A list of column names.
cos()[source]
cosh()[source]
cospi()[source]
countmatches(pattern)[source]

For each string in the column, count the occurrences of pattern.

Parameters:

pattern : str

The pattern to count matches on in each string.

Returns:

A single-column H2OFrame containing the counts for the per-row occurrences of

pattern in the input column.

cummax()[source]
Returns:The cumulative max over the column.
cummin()[source]
Returns:The cumulative min over the column.
cumprod()[source]
Returns:The cumulative product over the column.
cumsum()[source]
Returns:The cumulative sum over the column.
cut(breaks, labels=None, include_lowest=False, right=True, dig_lab=3)[source]

Cut a numeric vector into factor “buckets”. Similar to R’s cut method.

Parameters:

breaks : list

The cut points in the numeric vector (must span the range of the col.)

labels: list

Factor labels, defaults to set notation of intervals defined by breaks.

include_lowest : bool

By default, cuts are defined as (lo,hi]. If True, get [lo,hi].

right : bool

Include the high value: (lo,hi]. If False, get (lo,hi).

dig_lab: int

Number of digits following the decimal point to consider.

Returns:

Single-column H2OFrame of categorical data.

day()[source]
Returns:Day column from a msec-since-Epoch column
dayOfWeek()[source]
Returns:Day-of-Week column from a msec-since-Epoch column
ddply(cols, fun)[source]

Unimplemented

describe()[source]

Generate an in-depth description of this H2OFrame. Everything in summary(), plus the data layout.

digamma()[source]
dim None[source]
Returns:The number of rows and columns in the H2OFrame as a list [rows, cols].
drop(i)[source]

Drop a column from the current H2OFrame.

Parameters:

i : str, int

The column to be dropped

Returns:

H2OFrame with the column at index i dropped. Returns a new H2OFrame.

exp()[source]
expm1()[source]
filter_na_cols(frac=0.2)[source]

Filter columns with proportion of NAs >= frac.

Parameters:

frac : float

Fraction of NAs in the column.

Returns:

A list of column indices that have a fewer count of NAs.

If all columns are filtered, None is returned.

flatten()[source]
floor()[source]
frame_id None[source]
Returns:Get the name of this frame.
static from_python(python_obj, destination_frame='', header=(-1, 0, 1), separator='', column_names=None, column_types=None, na_strings=None)[source]

Properly handle native python data types. For a discussion of the rules and permissible data types please refer to the main documentation for H2OFrame.

Parameters:

python_obj : tuple, list, dict, collections.OrderedDict

If a nested list/tuple, then each nested collection is a row.

destination_frame : str, optional

The unique hex key assigned to the imported file. If none is given, a key will automatically be generated.

header : int, optional

-1 means the first line is data, 0 means guess, 1 means first line is header.

sep : str, optional

The field separator character. Values on each line of the file are separated by this character. If sep = “”, the parser will automatically detect the separator.

col_names : list, optional

A list of column names for the file.

col_types : list or dict, optional

A list of types or a dictionary of column names to types to specify whether columns should be forced to a certain type upon import parsing. If a list, the types for elements that are None will be guessed. The possible types a column may have are:

“unknown” - this will force the column to be parsed as all NA “uuid” - the values in the column must be true UUID or will be parsed as NA “string” - force the column to be parsed as a string “numeric” - force the column to be parsed as numeric. H2O will handle the

compression of the numeric data in the optimal manner.

“enum” - force the column to be parsed as a categorical column. “time” - force the column to be parsed as a time column. H2O will attempt to

parse the following list of date time formats.
date:

“yyyy-MM-dd” “yyyy MM dd” “dd-MMM-yy” “dd MMM yy”

time:

“HH:mm:ss” “HH:mm:ss:SSS” “HH:mm:ss:SSSnnnnnn” “HH.mm.ss” “HH.mm.ss.SSS” “HH.mm.ss.SSSnnnnnn”

Times can also contain “AM” or “PM”.

na_strings : list or dict, optional

A list of strings, or a list of lists of strings (one list per column), or a dictionary of column names to strings which are to be interpreted as missing values.

Returns:

A new H2OFrame instance.

Examples

>>> l = [[1,2,3,4,5], [99,123,51233,321]]
>>> l = H2OFrame(l)
>>> l
gamma()[source]
static get_frame(frame_id)[source]

Create an H2OFrame mapped to an existing id in the cluster.

Returns:H2OFrame that points to a pre-existing big data H2OFrame in the cluster
get_frame_data()[source]

Get frame data as str in csv format

Returns:

A local python string, each line is a row and each element separated by commas, containing this H2OFrame

instance’s data.

group_by(by)[source]
Returns a new GroupBy object using this frame and the desired grouping columns.
The returned groups are sorted by the natural group-by column sort.
Parameters:

by : list

The columns to group on.

Returns:

A new GroupBy object.

gsub(pattern, replacement, ignore_case=False)[source]

Globally substitute occurrences of pattern in a string with replacement.

Parameters:

pattern : str

A regular expression.

replacement : str

A replacement string.

ignore_case : bool

If True then pattern will match against upper and lower case.

Returns:

H2OFrame

head(rows=10, cols=200)[source]

Analogous to Rs head call on a data.frame.

Parameters:

rows : int, default=10

Number of rows starting from the topmost

cols : int, default=200

Number of columns starting from the leftmost

Returns:

An H2OFrame.

hist(breaks='Sturges', plot=True, **kwargs)[source]

Compute a histogram over a numeric column.

Parameters:

breaks: str, int, list

Can be one of “Sturges”, “Rice”, “sqrt”, “Doane”, “FD”, “Scott.” Can be a single number for the number of breaks. Can be a list containing sthe split points, e.g., [-50,213.2123,9324834] If breaks is “FD”, the MAD is used over the IQR in computing bin width.

plot : bool, default=True

If True, then a plot is generated

Returns:

If plot is False, return H2OFrame with these columns: breaks, counts, mids_true,

mids, and density; otherwise produce the plot.

hour()[source]
Returns:Hour-of-Day column from a msec-since-Epoch column
ifelse(yes, no)[source]

Equivalent to [y if t else n for t,y,n in zip(self,yes,no)]

Based on the booleans in the test vector, the output has the values of the yes and no vectors interleaved (or merged together). All Frames must have the same row count. Single column frames are broadened to match wider Frames. Scalars are allowed, and are also broadened to match wider frames.

Parameters:

test : H2OFrame (self)

Frame of values treated as booleans; may be a single column

yes : H2OFrame

Frame to use if [test] is true ; may be a scalar or single column

no : H2OFrame

Frame to use if [test] is false; may be a scalar or single column

Returns:

H2OFrame of the merged yes/no Frames/scalars according to the test input frame.

impute(column=-1, method='mean', combine_method='interpolate', by=None, group_by_frame=None, values=None)[source]

Impute in place.

Parameters:

column: int, default=-1

The column to impute, if -1 then impute the whole frame

method : str, default=”mean”

The method of imputation: mean, median, mode

combine_method : str, default=”interpolate”

When method is “median”, dictates how to combine quantiles for even samples.

by : list, default=None

The columns to group on.

group_by_frame : H2OFrame, default=None

Impute the column col with this pre-computed grouped frame.

values : list

A list of impute values (one per column). NaN indicates to skip the column.

Returns:

A list of values used in the imputation or the group by result used in imputation.

insert_missing_values(fraction=0.1, seed=None)[source]

Inserting Missing Values into an H2OFrame. This is primarily used for testing.

Randomly replaces a user-specified fraction of entries in a H2O dataset with missing values.

WARNING: This will modify the original dataset. Unless this is intended, this function should only be called on a subset of the original.

Parameters:

fraction : float

A number between 0 and 1 indicating the fraction of entries to replace with missing.

seed : int

A random number used to select which entries to replace with missing values.

Returns:

H2OFrame with missing values inserted.

interaction(factors, pairwise, max_factors, min_occurrence, destination_frame=None)[source]

Categorical Interaction Feature Creation in H2O. Creates a frame in H2O with n-th order interaction features between categorical columns, as specified by the user.

Parameters:

factors : list

factors Factor columns (either indices or column names).

pairwise : bool

Whether to create pairwise interactions between factors (otherwise create one higher-order interaction). Only applicable if there are 3 or more factors.

max_factors: int

Max. number of factor levels in pair-wise interaction terms (if enforced, one extra catch-all factor will be made)

min_occurrence: int

Min. occurrence threshold for factor levels in pair-wise interaction terms

destination_frame: str, optional

A string indicating the destination key.

Returns:

H2OFrame

is_src_in_self(src)[source]
ischaracter()[source]
Returns:True if the column is a character column, otherwise False (same as isstring)
isfactor()[source]

Test if the selection is a factor column. Returns ——-

True if the column is categorical; otherwise False. For String columns, the result is False.
isin(item)[source]

Test whether elements of an H2OFrame are contained in the item.

Parameters:

items : any element or a list of elements

An item or a list of items to compare the H2OFrame against.

Returns:

An H2OFrame of 0s and 1s showing whether each element in the original H2OFrame is contained in item.

isna()[source]

For each element in an H2OFrame, determine if it is NA or not.

Returns:H2OFrame of 1s and 0s. 1 means the value was NA.
isnumeric()[source]
Returns:True if the column is numeric, otherwise return False
isstring()[source]
Returns:True if the column is a string column, otherwise False (same as ischaracter)
kfold_column(n_folds=3, seed=-1)[source]

Build a fold assignments column for cross-validation. This call will produce a column having the same data layout as the calling object.

Parameters:

n_folds : int

An integer specifying the number of validation sets to split the training data into.

seed : int, optional

Seed for random numbers as fold IDs are randomly assigned.

Returns:

A single column H2OFrame with the fold assignments.

levels()[source]

Get the factor levels.

Returns:A list of lists, one list per column, of levels.
lgamma()[source]
log()[source]
log10()[source]
log1p()[source]
log2()[source]
logical_negation()[source]
match(table, nomatch=0)[source]

Makes a vector of the positions of (first) matches of its first argument in its second.

Parameters:
  • table
  • nomatch
Returns:

H2OFrame of one boolean column

max()[source]
Returns:The maximum value of all frame entries
mean(na_rm=False)[source]

Compute the mean.

Parameters:

na_rm: bool, default=False

If True, then remove NAs from the computation.

Returns:

A list containing the mean for each column (NaN for non-numeric columns).

median(na_rm=False)[source]

Compute the median.

Parameters:

na_rm: bool, default=False

If True, then remove NAs from the computation.

Returns:

A list containing the median for each column (NaN for non-numeric columns).

merge(other, all_x=False, all_y=False, by_x=None, by_y=None, method='auto')[source]

Merge two datasets based on common column names

Parameters:

other: H2OFrame

Other dataset to merge. Must have at least one column in common with self, and all columns in common are used as the merge key. If you want to use only a subset of the columns in common, rename the other columns so the columns are unique in the merged result.

all_x: bool, default=False

If True, include all rows from the left/self frame

all_y: bool, default=False

If True, include all rows from the right/other frame

Returns:

Original self frame enhanced with merged columns and rows

min()[source]
Returns:The minimum value of all frame entries
static mktime(year=1970, month=0, day=0, hour=0, minute=0, second=0, msec=0)[source]

All units are zero-based (including months and days). Missing year is 1970.

Parameters:

year : int, H2OFrame

month: int, H2OFrame day : int, H2OFrame hour : int, H2OFrame minute : int, H2OFrame second : int, H2OFrame msec : int, H2OFrame

Returns:

H2OFrame of one column containing the date in millis since the epoch.

modulo_kfold_column(n_folds=3)[source]

Build a fold assignments column for cross-validation. Rows are assigned a fold according to the current row number modulo n_folds.

Parameters:

n_folds : int

An integer specifying the number of validation sets to split the training data into.

Returns:

A single column H2OFrame with the fold assignments.

month()[source]
Returns:Month column from a msec-since-Epoch column
mult(matrix)[source]

Perform matrix multiplication.

Parameters:

matrix : H2OFrame

The right-hand-side matrix

Returns:

H2OFrame result of the matrix multiplication

na_omit()[source]

Remove rows with NAs from the H2OFrame.

Returns:H2OFrame
nacnt()[source]

Count of NAs for each column in this H2OFrame.

Returns:A list of the na cnts (one entry per column).
names None[source]

Retrieve the column names (one name per H2OVec) for this H2OFrame.

Returns:A str list of column names
nchar()[source]

Count the number of characters in each string of single-column H2OFrame.

Returns:A single-column H2OFrame containing the per-row character count.
ncol None[source]
Returns:The number of columns in the H2OFrame.
nlevels()[source]

Get the number of factor levels for this frame.

Returns:A list of the number of levels per column.
nrow None[source]
Returns:The number of rows in the H2OFrame.
pop(i)[source]

Pop a column from the H2OFrame at index i

Parameters:

i : int, str

The index or name of the column to pop.

Returns:

The column dropped from the frame; the frame is side-effected to lose the column.

prod(na_rm=False)[source]
Parameters:

na_rm : bool, default=False

True or False to remove NAs from computation.

Returns:

The product of the column.

quantile(prob=None, combine_method='interpolate', weights_column=None)[source]

Compute quantiles.

Parameters:

prob : list, default=[0.01,0.1,0.25,0.333,0.5,0.667,0.75,0.9,0.99]

A list of probabilities of any length.

combine_method : str, default=”interpolate”

For even samples, how to combine quantiles. Should be one of [“interpolate”, “average”, “low”, “hi”]

weights_column : str, default=None

Name of column with optional observation weights in this H2OFrame or a 1-column H2OFrame of observation weights.

Returns:

A new H2OFrame containing the quantiles and probabilities.

rbind(data)[source]

Combine H2O Datasets by rows. Takes a sequence of H2O data sets and combines them by rows.

Parameters:data : H2OFrame
Returns:Returns this H2OFrame with data appended row-wise.
rep_len(length_out)[source]

Replicates the values in data in the H2O backend

Parameters:

length_out : int

Number of columns of the resulting H2OFrame

Returns:

H2OFrame

round(digits=0)[source]

Round doubles/floats to the given number of decimal places.

Parameters:

digits : int, default=0

Number of decimal places to round doubles/floats. Rounding to a negative number of decimal places is not supported. For rounding off a 5, the IEC 60559 standard is used, ‘go to the even digit’. Therefore rounding 2.5 gives 2 and rounding 3.5 gives 4.

Returns:

H2OFrame

runif(seed=None)[source]

Generate a column of random numbers drawn from a uniform distribution [0,1) and having the same data layout as the calling H2OFrame instance.

Parameters:

seed : int, optional

A random seed. If None, then one will be generated.

Returns:

Single-column H2OFrame filled with doubles sampled uniformly from [0,1).

scale(center=True, scale=True)[source]

Centers and/or scales the columns of the self._newExpr

Parameters:

center : bool, list

If True, then demean the data by the mean. If False, no shifting is done. If a list, then shift each column by the given amount in the list.

scale : bool, list

If True, then scale the data by the column standard deviation. If False, no scaling is done. If a list, then scale each column by the given amount in the list.

Returns:

H2OFrame

sd(na_rm=False)[source]

Compute the standard deviation.

Parameters:

na_rm : bool, default=False

Remove NAs from the computation.

Returns:

A list containing the standard deviation for each column (NaN for non-numeric

columns).

set_level(level)[source]

A method to set all column values to one of the levels.

Parameters:

level : str

The level at which the column will be set (a string)

Returns:

H2OFrame with entries set to the desired level.

set_levels(levels)[source]

Works on a single categorical column. New domains must be aligned with the old domains. This call has copy-on-write semantics.

Parameters:

levels : list

A list of strings specifying the new levels. The number of new levels must match the number of old levels.

Returns:

A single-column H2OFrame with the desired levels.

set_name(col=None, name=None)[source]

Set the name of the column at the specified index.

Parameters:

col : int, str

Index of the column whose name is to be set; may be skipped for 1-column frames

name : str

The new name of the column to set

Returns:

Returns self.

set_names(names)[source]

Change all of this H2OFrame instance’s column names.

Parameters:

names : list

A list of strings equal to the number of columns in the H2OFrame.

shape None[source]
Returns:A tuple (nrow, ncol)
show(use_pandas=False)[source]

Used by the H2OFrame.__repr__ method to print or display a snippet of the data frame. If called from IPython, displays an html’ized result Else prints a tabulate’d result

sign()[source]
signif(digits=6)[source]

Round doubles/floats to the given number of significant digits.

Parameters:

digits : int, default=6

Number of significant digits to round doubles/floats.

Returns:

H2OFrame

sin()[source]
sinh()[source]
sinpi()[source]
split_frame(ratios=None, destination_frames=None, seed=None)[source]

Split a frame into distinct subsets of size determined by the given ratios. The number of subsets is always 1 more than the number of ratios given.

Parameters:

ratios : list

The fraction of rows for each split.

destination_frames : list

The names of the split frames.

seed : int

Used for selecting which H2OFrame a row will belong to.

Returns:

A list of H2OFrame instances

sqrt()[source]
stratified_kfold_column(n_folds=3, seed=-1)[source]

Build a fold assignment column with the constraint that each fold has the same class distribution as the fold column.

Parameters:

n_folds: int

The number of folds to build.

seed: int

A random seed.

Returns:

A single column H2OFrame with the fold assignments.

stratified_split(test_frac=0.2, seed=-1)[source]

Construct a column that can be used to perform a random stratified split.

Parameters:

test_frac : float, default=0.2

The fraction of rows that will belong to the “test”.

seed : int

For seeding the random splitting.

Returns:

A categorical column of two levels “train” and “test”.

Examples

>>> my_stratified_split = my_frame["response"].stratified_split(test_frac=0.3,seed=12349453)
>>> train = my_frame[my_stratified_split=="train"]
>>> test  = my_frame[my_stratified_split=="test"]

# check the distributions among the initial frame, and the train/test frames match >>> my_frame[“response”].table()[“Count”] / my_frame[“response”].table()[“Count”].sum() >>> train[“response”].table()[“Count”] / train[“response”].table()[“Count”].sum() >>> test[“response”].table()[“Count”] / test[“response”].table()[“Count”].sum()

strsplit(pattern)[source]

Split the strings in the target column on the given pattern

Parameters:

pattern : str

The split pattern.

Returns:

H2OFrame containing columns of the split strings.

structure()[source]

Similar to R’s str method: Compactly Display the Structure of this H2OFrame.

sub(pattern, replacement, ignore_case=False)[source]

Substitute the first occurrence of pattern in a string with replacement.

Parameters:

pattern : str

A regular expression.

replacement : str

A replacement string.

ignore_case : bool

If True then pattern will match against upper and lower case.

Returns:

H2OFrame

substring(start_index, end_index=None)[source]

For each string, return a new string that is a substring of the original string. If end_index is not specified, then the substring extends to the end of the original string. If the start_index is longer than the length of the string, or is greater than or equal to the end_index, an empty string is returned. Negative start_index is coerced to 0.

Parameters:

start_index : int

The index of the original string at which to start the substring, inclusive.

end_index: int, optional

The index of the original string at which to end the substring, exclusive.

Returns:

An H2OFrame containing the specified substrings.

sum(na_rm=False)[source]
Returns:The sum of all frame entries
summary()[source]

Summary: show(), plus includes min/mean/max/sigma and other rollup data

table(data2=None, dense=True)[source]

Compute the counts of values appearing in a column, or co-occurence counts between two columns.

Parameters:

data2 : H2OFrame

Default is None, can be an optional single column to aggregate counts by.

dense : bool

Default is True, for dense representation, which lists only non-zero counts, 1 combination per row. Set to False to expand counts across all combinations.

Returns:

H2OFrame of the counts at each combination of factor levels

tail(rows=10, cols=200)[source]

Analogous to Rs tail call on a data.frame.

Parameters:

rows : int, default=10

Number of rows starting from the bottommost

cols: int, default=200

Number of columns starting from the leftmost

Returns:

An H2OFrame.

tan()[source]
tanh()[source]
tanpi()[source]
tolower()[source]

Translate characters from upper to lower case for a particular column

Returns:H2OFrame
toupper()[source]

Translate characters from lower to upper case for a particular column

Returns:H2OFrame
transpose()[source]

Transpose rows and columns of H2OFrame.

Returns:The transpose of the input frame.
trigamma()[source]
trim()[source]

Trim white space on the left and right of strings in a single-column H2OFrame.

Returns:H2OFrame with trimmed strings.
trunc()[source]
type(name)[source]
Returns:The type for a named column
types None[source]
Returns:A dictionary of column_name-type pairs.
unique()[source]

Extract the unique values in the column.

Returns:H2OFrame of just the unique values in the column.
var(y=None, na_rm=False, use=None)[source]

Compute the variance or covariance matrix of one or two H2OFrames.

Parameters:

y : H2OFrame, default=None

If y is None and self is a single column, then the variance is computed for self. If self has multiple columns, then its covariance matrix is returned. Single rows are treated as single columns. If y is not None, then a covariance matrix between the columns of self and the columns of y is computed.

na_rm : bool, default=False

Remove NAs from the computation.

use : str, default=None, which acts as “everything” if na_rm is False, and “complete.obs” if na_rm is True

A string indicating how to handle missing values. This must be one of the following:

“everything” - outputs NaNs whenever one of its contributing observations is missing “all.obs” - presence of missing observations will throw an error “complete.obs” - discards missing values along with all observations in their rows so that only complete observations are used “pairwise.complete.obs” - uses all complete pairs of observations

Returns:

An H2OFrame of the covariance matrix of the columns of this H2OFrame with itself (if y is not given), or with the columns of y

(if y is given). If self and y are single rows or single columns, the variance or covariance is given as a scalar.

week()[source]
Returns:Week column from a msec-since-Epoch column
which()[source]

Equivalent to [ index for index,value in enumerate(self) if value ]

Returns:

Single-column H2OFrame filled with 0-based indices for which the elements are not

zero.

year()[source]
Returns:Year column from a msec-since-Epoch column

GroupBy

class h2o.group_by.GroupBy(fr, by)[source]

A class that represents the group by operation on an H2OFrame.

Sample usage:

>>> my_frame = ...  # some existing H2OFrame
>>> grouped = my_frame.group_by(by=["C1","C2"])
>>> grouped.sum(col="X1",na="all").mean(col="X5",na="all").max()
>>> grouped.get_frame

Any number of aggregations may be chained together in this manner.

If no arguments are given to the aggregation (e.g. “max” in the above example), then it is assumed that the aggregation should apply to all columns but the group by columns.

The na parameter is one of [“all”,”ignore”,”rm”].
“all” - include NAs “rm” - exclude NAs

Variance (var) and standard deviation (sd) are the sample (not population) statistics.

Attributes

frame

Methods

count
get_frame
max
mean
min
mode
sd
ss
sum
var
count(na='all')[source]
frame None[source]
Returns:the result of the group by
get_frame()[source]
Returns:the result of the group by
max(col=None, na='all')[source]
mean(col=None, na='all')[source]
min(col=None, na='all')[source]
mode(col=None, na='all')[source]
sd(col=None, na='all')[source]
ss(col=None, na='all')[source]
sum(col=None, na='all')[source]
var(col=None, na='all')[source]