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

Codelabs! #339

Closed
cwbeitel opened this issue Mar 1, 2020 · 2 comments
Closed

Codelabs! #339

cwbeitel opened this issue Mar 1, 2020 · 2 comments

Comments

@cwbeitel
Copy link

cwbeitel commented Mar 1, 2020

As per our (currently my) discussion in the trax gitter there is significant interest in there being Trax codelabs. Here's a live prototype or a screenshot to get the feel:

Screenshot 2020-02-29 at 6 49 04 PM

As I mentioned in the Trax gitter while this might mirror the content of a notebook someone could just use on colab it could potentially provide some added benefit by helping to reduce cognitive load. But also as I mentioned there there can be colabs as well codelabs compiled from the colabs 😉

E.g. a notebook and a markdown that is being used to generate the codelab in the linked prototype

Hosting this on our docs site just for demo purposes. Prototype was a fork of the open-wc codelab package which was generated using https://github.com/googlecodelabs/tools iiuc.

Related but separate is the possibility of there being a trax docs site? 😏 We did ours with Vuepress (again forked from openwc) which is working out really well.

@cwbeitel
Copy link
Author

cwbeitel commented Mar 1, 2020

The screenshot I added above is of my favorite because it's illustrating how you can take a small amount of information that's easy to gloss over and go into a lot of detail line by line to make sure everything in conveyed. Indeed which you can do in a notebook but again this seems easier to think about because you're only being shown info about this one operation (trainer.train_epoch)

@cwbeitel
Copy link
Author

@afrozenator I get the vibe this approach isn't of interest, in favor of the more lean notebook and github markdown approach, so I'll go ahead and close this. Feel free to re-open.

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

No branches or pull requests

1 participant