Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More documentation fixen #255

Open
wants to merge 4 commits into
base: masterr
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/dummy_torch.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Dummy Torch Model
==================

These models were created solely for testing purposes. They provide a known result in order to test logic of train/validation/test loops and functions.

.. automodule:: flood_forecast.transformer_xl.dummy_torch
:members:
2 changes: 2 additions & 0 deletions docs/source/evaluator.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Model Evaluation
=================

Flow Forecast has built in model evaluation capabilities. Model evaluation is called automatically when using the train function.

.. automodule:: flood_forecast.evaluator
:members:
8 changes: 5 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Welcome to Flow Forecast's documentation!
=========================================

Flow Forecast is a deep learning for time series forecasting framework written in PyTorch. Flow Forecast makes it easy to train PyTorch Forecast models on a wide variety
of datasets.
of datasets. Please note that documentation for APIs is provided here. This is good if you want to leverage the underlying Flow Forecast APIs and learn about the specific
parameters for models. However, if you are looking for conceptual information, using the configuration files, or benchmarks please vist our `confluence site <https://flow-forecast.atlassian.net/wiki/spaces/FF/overview>`_.

.. automodule:: flood_forecast

Expand Down Expand Up @@ -60,7 +61,7 @@ of datasets.

.. toctree::
:maxdepth: 2
:caption: TransformerXL:
:caption: Transformer Model:

dummy_torch
lower_upper_config
Expand All @@ -81,7 +82,8 @@ of datasets.

.. toctree::
:maxdepth: 3
:caption: DA RNN:
:caption: DA-RNN:

model


Expand Down
4 changes: 4 additions & 0 deletions docs/source/inference.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Inference
=========================

Flow Forecast has a dedicated inference API to make it easy to deploy time series forecasting, classification, and anomaly detection models. Below is the core documentation of
the inference API. For an authoritative tutorial on using the inference API
`please see this notebook <https://colab.research.google.com/drive/1IQO2dBaMqZxN5v9HLQvzlvFLM5__VFZP>`_.

.. automodule:: flood_forecast.deployment.inference
:members: