-
-
Notifications
You must be signed in to change notification settings - Fork 432
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
Added ARCHITECTURE.md #471
base: master
Are you sure you want to change the base?
Conversation
|
||
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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`. |
|
||
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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). |
|
||
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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). |
TODO | ||
|
||
### `*goMachine` ### | ||
TODO |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO | |
The GoMachine is documented on Gorgonia's website [gorgonia.org/reference/vm/gomachine/](https://gorgonia.org/reference/vm/gomachine/) |
This is a general comment about the name (and naming is hard). As I don't have any other relevant name to offer, I propose to move this document to a |
README.md in the docs folder? |
Codecov Report
@@ Coverage Diff @@
## master #471 +/- ##
=======================================
Coverage 55.41% 55.41%
=======================================
Files 71 71
Lines 11597 11597
=======================================
Hits 6426 6426
Misses 4324 4324
Partials 847 847
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
what about DESIGN.md ? |
No description provided.