-
-
Notifications
You must be signed in to change notification settings - Fork 0
Docs update #15
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
Merged
Docs update #15
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
3725019
major additions to lab docs. I need this stuff..
rcoreilly bb0f001
support for printing stdout to RO texteditor in yaegilab and docs; ne…
rcoreilly 68c2a6f
switch over to printing for all output in lab docs; output logic move…
rcoreilly 0f281c6
docs: basic math docs done, tensorfs list output redirects properly.
rcoreilly 5dea55d
docs: better processing of ../ in tensorfs
rcoreilly 710c149
docs: add tensor.AnySlice to process all indexed exprs in goal math m…
rcoreilly 34f6075
update core
kkoreilly 52b2dc4
docs: unclear why table not generating output
rcoreilly 00eb8f6
docs: table and stats done, including grouping
rcoreilly c489893
docs: update to latest yaegi and remove tensor.DataTypes based generi…
rcoreilly c5d00b3
docs: merge main into docs
rcoreilly 2aabd5a
docs: forgot to cleanup README after moving most of content to docs -…
rcoreilly bbc06fb
docs: rest of readme cleanup -- now ready for review
rcoreilly 6a57e17
docs: kai issues
rcoreilly d27325e
docs: fix categories, etc
rcoreilly 98e10f7
docs: update to latest core
rcoreilly ee32187
docs: remove .String(), other fixes
rcoreilly 310525a
docs: tensorfs typo
rcoreilly File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| +++ | ||
| Categories = ["Lab"] | ||
| +++ | ||
|
|
||
| See `examples/planets` and `examples/simstats` for example uses of the **Browser** graphical interface. Go API docs: [[doc:lab.Browser]] | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| +++ | ||
| Categories = ["Stats"] | ||
| +++ | ||
|
|
||
| **Cluster** computes agglomerative clustering. Go docs: [[doc:stats/cluster]] | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| +++ | ||
| Categories = ["Lab"] | ||
| +++ | ||
|
|
||
| **DataTree** provides a [core/filetree](https://cogentcore.org/core/filetree) with support for standard data types, including viewing a [[tensorfs]] virtual filesystem, as part of a data [[Browser]]. | ||
|
|
||
| Go API docs: [[doc:lab.DataTree]] | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| +++ | ||
| Categories = ["Stats"] | ||
| +++ | ||
|
|
||
| **glm** computes generalized linear models. Go docs: [[doc:stats/glm]] | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| **Goal** is the _Go augmented language_ with support for two additional modes, in addition to standard Go: | ||
|
|
||
| * [[shell|$ shell mode $]] that operates like a standard command-line shell (e.g., `bash`), with space-separated elements and standard shell functionality including input / output redirection. Goal automatically detects most instances of shell mode based on the syntax of the line, but it can always be explicitly indicated with surrounding `$`s. | ||
|
|
||
| * [[math|# math mode #]] that supports Python-like concise mathematical expressions operating on [[tensor]] elements. | ||
|
|
||
| Here is an example of shell-mode mixing Go and shell code: | ||
|
|
||
| ```goal | ||
| for i, f := range goalib.SplitLines($ls -la$) { // ls executes, returns string | ||
| echo {i} {strings.ToLower(f)} // {} surrounds Go within shell | ||
| } | ||
| ``` | ||
|
|
||
| where Go-code is explicitly indicated by the `{}` braces. | ||
|
|
||
| Here is an example of math-mode: | ||
| ```goal | ||
| # x := 1. / (1. + exp(-wts[:, :, :n] * acts[:])) | ||
| ``` | ||
|
|
||
| You can also intermix math within Go code: | ||
| ```goal | ||
| for _, x := range #[1,2,3]# { | ||
| fmt.Println(#x**2#) | ||
| } | ||
| ``` | ||
|
|
||
| Goal can be used in an interpreted mode by using the [yaegi](https://github.com/traefik/yaegi) Go interpreter (and can be used as your shell executable in a terminal), and it can also replace the standard `go` compiler in command-line mode, to build compiled executables using the extended Goal syntax. | ||
|
|
||
| A key design feature of Goal is that it always _transpiles directly to Go_ in a purely syntactically driven way, so the output of Goal is pure Go code. | ||
|
|
||
| Goal can also be used in conjunction with [[gosl]] to build programs that transparently run on GPU hardware in addition to standard CPUs (as standard Go programs). | ||
|
|
||
| ## Goal pages | ||
|
|
||
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| +++ | ||
| Categories = ["Stats"] | ||
| +++ | ||
|
|
||
| **Histogram** computes histograms. Go docs: [[doc:stats/histogram]] | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
|
|
||
| **Lab** contains graphical interface elements for Cogent Lab (Go docs: [[doc:lab]]), including: | ||
|
|
||
| * [[Browser]] is a default combination of the following elements. | ||
|
|
||
| * [[Tabs]] provides functions for creating tabs with data elements such as [[plot]]s and views of [[table]]s. | ||
|
|
||
| * [[DataTree]] provides a tree-structured view of [[tensorfs]] and regular filesystem data. | ||
|
|
||
| ## Lab pages | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.