Skip to content

Commit

Permalink
address comments in code ref home page PR
Browse files Browse the repository at this point in the history
  • Loading branch information
@ianspektor
ianspektor committed Jun 19, 2023
1 parent 12a1de0 commit 613c101
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 2 deletions.
89 changes: 88 additions & 1 deletion docs/src/reference/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,91 @@

Temporian's API Reference.

<!-- TODO: write reference home page. Include table of operators. -->
Check the index on the left for a more detailed description of any symbol.

## Classes

| Symbol | Description |
| ----------------------------------- | ---------------------------------------------------------------------------------------------- |
| [`tp.Node`][temporian.Node] | Reference to the input or output of an operator in the compute graph. |
| [`tp.EventSet`][temporian.EventSet] | Container for actual temporal data. |
| [`tp.Schema`][temporian.Schema] | Description of the data inside a [`Node`][temporian.Node] or [`EventSet`][temporian.EventSet]. |

## Functions

| Symbol | Description |
| ----------------------------------------- | -------------------------------------------------------------------------------------- |
| [`tp.evaluate()`][temporian.evaluate] | Evaluates [`Nodes`][temporian.Node] on [`EventSets`][temporian.EventSet]. |
| [`tp.plot()`][temporian.plot] | Plots [`EventSets`][temporian.EventSet]. |
| [`tp.event_set()`][temporian.event_set] | Creates an [`EventSet`][temporian.EventSet] from arrays (lists, NumPy, Pandas Series.) |
| [`tp.input_node()`][temporian.input_node] | Creates an input [`Node`][temporian.Node], that can be used to feed data into a graph. |

## Input/output

| Symbol | Description |
| ------------------------------------------- | --------------------------------------------------------------------- |
| [`tp.from_pandas()`][temporian.from_pandas] | Converts a Pandas DataFrame into an [`EventSet`][temporian.EventSet]. |
| [`tp.to_pandas()`][temporian.to_pandas] | Converts an [`EventSet`][temporian.EventSet] to a pandas DataFrame. |
| [`tp.from_csv()`][temporian.from_csv] | Reads an [`EventSet`][temporian.EventSet] from a CSV file. |
| [`tp.to_csv()`][temporian.to_csv] | Saves an [`EventSet`][temporian.EventSet] to a CSV file. |

## Durations

| Symbols | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [`tp.duration.milliseconds()`][temporian.duration.milliseconds] [`tp.duration.seconds()`][temporian.duration.seconds] [`tp.duration.minutes()`][temporian.duration.minutes] [`tp.duration.hours()`][temporian.duration.hours] [`tp.duration.days()`][temporian.duration.days] [`tp.duration.weeks()`][temporian.duration.weeks] | Convert input value from milliseconds / seconds / minutes / hours / days / weeks to a `Duration` in seconds. |

## Operators

| Symbols | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| [`tp.add_index()`][temporian.add_index] | Adds one or more features as index in a [`Node`][temporian.Node]. |
| [`tp.begin()`][temporian.begin] | Generates a single timestamp at the beginning of the input. |
| [`tp.cast()`][temporian.cast] | Casts the dtype of features. |
| [`tp.drop_index()`][temporian.drop_index] | Removes one or more index columns from a [`Node`][temporian.Node]. |
| [`tp.end()`][temporian.end] | Generates a single timestamp at the end of the input. |
| [`tp.filter()`][temporian.filter] | Filters out events in a [`Node`][temporian.Node] for which a condition is false. |
| [`tp.glue()`][temporian.glue] | Concatenates [`Nodes`][temporian.Node] with the same sampling. |
| [`tp.lag()`][temporian.lag] | Adds a delay to a [`Node`][temporian.Node]'s timestamps. |
| [`tp.leak()`][temporian.leak] | Subtracts a duration from a [`Node`][temporian.Node]'s timestamps. |
| [`tp.prefix()`][temporian.prefix] | Adds a prefix to the names of the features in a [`Node`][temporian.Node]. |
| [`tp.propagate()`][temporian.propagate] | Propagates feature values over a sub index. |
| [`tp.rename()`][temporian.rename] | Renames a [`Node`][temporian.Node]'s features and index. |
| [`tp.resample()`][temporian.resample] | Resamples a [`Node`][temporian.Node] at each timestamp of another [`Node`][temporian.Node]. |
| [`tp.select()`][temporian.select] | Selects a subset of features from a [`Node`][temporian.Node]. |
| [`tp.since_last()`][temporian.since_last] | Computes the amount of time since the last distinct timestamp. |
| [`tp.tick()`][temporian.tick] | Generates timestamps at regular intervals in the range of a guide. |
| [`tp.unique_timestamps()`][temporian.unique_timestamps] | Removes events with duplicated timestamps from a [`Node`][temporian.Node]. |

### Binary operators

| Symbols | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [`tp.add()`][temporian.add] [`tp.subtract()`][temporian.subtract] [`tp.multiply()`][temporian.multiply] [`tp.divide()`][temporian.divide] [`tp.floordiv()`][temporian.floordiv] [`tp.modulo()`][temporian.modulo] [`tp.power()`][temporian.power] | Compute an arithmetic binary operation between two [`Nodes`][temporian.Node]. Aliases for `+`, `-`, `\*`, `/`, etc. |
| [`tp.equal()`][temporian.equal] [`tp.not_equal()`][temporian.not_equal] [`tp.greater()`][temporian.greater] [`tp.greater_equal()`][temporian.greater_equal] [`tp.less()`][temporian.less] [`tp.less_equal()`][temporian.less_equal] | Compute a relational binary operator between two [`Nodes`][temporian.Node]. |
| [`tp.logical_and()`][temporian.logical_and] [`tp.logical_or()`][temporian.logical_or] [`tp.logical_xor()`][temporian.logical_xor] | Compute a logical binary operation between two [`Nodes`][temporian.Node]. |

### Unary operators

| Symbols | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [`tp.abs()`][temporian.abs] [`tp.log()`][temporian.log] [`tp.invert()`][temporian.invert] [`tp.isnan()`][temporian.isnan] [`tp.notnan()`][temporian.notnan] | Compute unary operations on a [`Node`][temporian.Node]. |

### Calendar operators

| Symbols | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| [`tp.calendar_day_of_month()`][temporian.calendar_day_of_month] [`tp.calendar_day_of_week()`][temporian.calendar_day_of_week] [`tp.calendar_day_of_year()`][temporian.calendar_day_of_year] [`tp.calendar_hour()`][temporian.calendar_hour] [`tp.calendar_iso_week()`][temporian.calendar_iso_week] [`tp.calendar_minute()`][temporian.calendar_minute] [`tp.calendar_month()`][temporian.calendar_month] [`tp.calendar_second()`][temporian.calendar_second] [`tp.calendar_year()`][temporian.calendar_year] | Obtain the day of month / day of week / day of year / hour / ISO week / minute / month / second / year the timestamps in a Node are in. |

### Scalar operators

| Symbols | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [`tp.add_scalar()`][temporian.add_scalar] [`tp.subtract_scalar()`][temporian.subtract_scalar] [`tp.multiply_scalar()`][temporian.multiply_scalar] [`tp.divide_scalar()`][temporian.divide_scalar] [`tp.floordiv_scalar()`][temporian.floordiv_scalar] [`tp.modulo_scalar()`][temporian.modulo_scalar] [`tp.power_scalar()`][temporian.power_scalar] | Compute an arithmetic operation between a [`Node`][temporian.Node] and a scalar value. |
| [`tp.equal_scalar()`][temporian.equal_scalar] [`tp.not_equal_scalar()`][temporian.not_equal_scalar] [`tp.greater_equal_scalar()`][temporian.greater_equal_scalar] [`tp.greater_scalar()`][temporian.greater_scalar] [`tp.less_equal_scalar()`][temporian.less_equal_scalar] [`tp.less_scalar()`][temporian.less_scalar] | Compute a relational operation between a [`Node`][temporian.Node] and a scalar value. |

### Window operators

| Symbols | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`tp.simple_moving_average()`][temporian.simple_moving_average] [`tp.moving_standard_deviation()`][temporian.moving_standard_deviation] [`tp.cumsum()`][temporian.cumsum] [`tp.moving_sum()`][temporian.moving_sum] [`tp.moving_count()`][temporian.moving_count] [`tp.moving_min()`][temporian.moving_min] [`tp.moving_max()`][temporian.moving_max] | Compute an operation on the values in a sliding window over a Node's timestamps. |
3 changes: 2 additions & 1 deletion temporian/implementation/numpy/data/io.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ def event_set(
is_unix_timestamp: Optional[bool] = None,
same_sampling_as: Optional[EventSet] = None,
) -> EventSet:
"""Creates an event set from arrays (list, numpy, pandas).
"""Creates an [`EventSet`][temporian.EventSet] from arrays (lists, NumPy,
Pandas Series.)
Usage examples:
Expand Down

0 comments on commit 613c101

Please sign in to comment.