Skip to content

Added ARCHITECTURE.md#471

Open
chewxy wants to merge 7 commits intomasterfrom
architecture.md
Open

Added ARCHITECTURE.md#471
chewxy wants to merge 7 commits intomasterfrom
architecture.md

Conversation

@chewxy
Copy link
Copy Markdown
Member

@chewxy chewxy commented Feb 9, 2021

No description provided.

Comment thread ARCHITECTURE.md

Hence for simplicity's sake, there is no difference between an operator and a function in Gorgonia. They are all treated as functions, but named `Op`. The `Op`s in Gorgonia may be found in files starting with `op_`.

The definition of the `Op` interface may be found in `op.go`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The definition of the `Op` interface may be found in `op.go`.
The definition of the [`Op`](https://pkg.go.dev/gorgonia.org/gorgonia#Op) interface may be found in `op.go`.

Comment thread ARCHITECTURE.md

Hence when we perform a symbolic differentiation, we're adding new `*Node`s to the graph, each representing a partial derivative of ![c](https://render.githubusercontent.com/render/math?math=%5Ctextstyle+c) with regards to ![a](https://render.githubusercontent.com/render/math?math=%5Ctextstyle+a) or ![b](https://render.githubusercontent.com/render/math?math=%5Ctextstyle+b).

An `Op` that supports symbolic differentiation must implement `SDOp`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
An `Op` that supports symbolic differentiation must implement `SDOp`.
An `Op` that supports symbolic differentiation must implement [`SDOp`](https://pkg.go.dev/gorgonia.org/gorgonia#SDOp).

Comment thread ARCHITECTURE.md

To aid in automatic differentiation, a `dualValue` type is also used. A `*dualValue` is exactly what it suggests: a value that contains two values - usually the value and a gradient.

An `Op` that supports automatic differentiation must implement `ADOp`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
An `Op` that supports automatic differentiation must implement `ADOp`.
An `Op` that supports automatic differentiation must implement [`ADOp`](https://pkg.go.dev/gorgonia.org/gorgonia#ADOp).

Comment thread ARCHITECTURE.md
TODO

### `*goMachine` ###
TODO
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
TODO
The GoMachine is documented on Gorgonia's website [gorgonia.org/reference/vm/gomachine/](https://gorgonia.org/reference/vm/gomachine/)

@owulveryck
Copy link
Copy Markdown
Member

This is a general comment about the name (and naming is hard).
Architecture is about the important stuff, whatever it is. Nevertheless, in our context, naming this doc ARCHITECTURE is a bit misleading for the user.

As I don't have any other relevant name to offer, I propose to move this document to a docs folder.
People seeking documentation will go there and open the only doc present (whatever its name), and somehow, once we have other exciting stuff to put there, we can rename ARCHITECTURE.md

@chewxy
Copy link
Copy Markdown
Member Author

chewxy commented Feb 15, 2021

README.md in the docs folder?

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 15, 2021

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.41%. Comparing base (0526c98) to head (a0c6e8c).
⚠️ Report is 33 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #471   +/-   ##
=======================================
  Coverage   55.41%   55.41%           
=======================================
  Files          71       71           
  Lines       11597    11597           
=======================================
  Hits         6426     6426           
  Misses       4324     4324           
  Partials      847      847           
Flag Coverage Δ
unittests 55.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dcu
Copy link
Copy Markdown
Collaborator

dcu commented Mar 28, 2021

what about DESIGN.md ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants