Skip to content

[Relay][Docs] Documentation for Algebraic Data Types #2575

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.

Sign up for GitHub

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

Merged
tqchen merged 17 commits into from
Feb 18, 2019
Merged

[Relay][Docs] Documentation for Algebraic Data Types #2575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a1dc2ec
First pass on ADT doc
slyubomirsky Feb 6, 2019
1476632
Finish the rest of the ADT description
slyubomirsky Feb 7, 2019
a265433
Typos and minor corrections
slyubomirsky Feb 7, 2019
cf5baef
Unbalanced parens
slyubomirsky Feb 7, 2019
4aa01da
Update existing lang ref pages to refernce ADT docs and describe ADT …
slyubomirsky Feb 8, 2019
588c242
Missing parentheses in example
slyubomirsky Feb 8, 2019
6458f85
Reorder words less confusingly
slyubomirsky Feb 8, 2019
be18b60
Incorporate various corrections from @jospoll
joshpoll Feb 11, 2019
267ffe1
Clarifications and rephrasings in ADT overview
slyubomirsky Feb 11, 2019
7de3809
More detail in ADT overview
slyubomirsky Feb 11, 2019
fb40ee5
Address further feedback, give more examples
slyubomirsky Feb 11, 2019
a12ee7e
Rename 'Option' to 'Optional' for consistency with Python
slyubomirsky Feb 11, 2019
af1e6f7
Add RNN examples to ADT doc
slyubomirsky Feb 13, 2019
32cb915
Minor tweaks to code snippets
slyubomirsky Feb 13, 2019
e8d0256
Add note that Relay's Prelude includes iterators used in the examples
slyubomirsky Feb 15, 2019
8c0b13d
Corrections and addressed feedback
slyubomirsky Feb 15, 2019
c06b802
Correct various RST errors, ensure it displays properly
slyubomirsky Feb 15, 2019
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
10 changes: 6 additions & 4 deletions docs/langref/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Introduction to Relay

Relay is a functional, differentiable programming language
designed to be an expressive intermediate representation for machine
learning systems. Relay supports closures, control flow, and
recursion, allowing it to directly represent more complex models
than can computation graph-based IRs.
learning systems. Relay supports algebraic data types, closures,
control flow, and recursion, allowing it to directly represent more
complex models than computation graph-based IRs can.
Relay also includes a form of dependent typing using *type relations*
in order to handle shape analysis for operators with complex
requirements on argument shapes.
Expand All @@ -19,13 +19,15 @@ Relay is extensible by design and makes it easy for machine learning
researchers and practitioners to develop new large-scale program
transformations and optimizations.

The below pages describe the grammar, type system, and operators in Relay, respectively.
The below pages describe the grammar, type system,
algebraic data types, and operators in Relay, respectively.

.. toctree::
:maxdepth: 2

relay_expr
relay_type
relay_adt
relay_op

Hybrid Script
Expand Down
Loading