Skip to content

Commit

Permalink
contrib: more content guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Aug 22, 2023
1 parent 0fbca28 commit a6d4e91
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
5 changes: 4 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@
- [ ] chapter content
+ [ ] only one top-level `# h1-Title`
+ [ ] summary (e.g. table), no need for an explicit `## Summary/Introduction` title or equivalent
+ [ ] summary (e.g. table or TL;DR overview), no need for an explicit `## Summary/Introduction` title or equivalent
+ [ ] main content focus: recent developments in open source AI
+ general context/background (brief)
+ current pros/cons
+ in-depth insights (not yet widely known)
+ [ ] likely `## Future` developments
+ [ ] end with `{{ comments }}`
- [ ] appropriate citations
Expand Down
8 changes: 7 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,11 @@ Don't worry about making it perfect, it's fine to open a (`draft <https://docs.g
+ please use https://github.com/premAI-io/static.premai.io to host images & data

- [](glossary) term: {term}`GPU`
+ custom inline text: {term}`GPUs <GPU>`
- [BibTeX](https://jupyterbook.org/en/stable/tutorials/references.html#add-your-references) `references.bib` citation: {cite}`python`

% comment lines (not rendered) are prefixed with a "%"

### Contributors

{{ '[![](https://contrib.rocks/image?repo=' + '/'.join(repo_url.split('/')[-2:]) + ')](' + repo_url + '/graphs/contributors)' }}
Expand All @@ -118,14 +121,17 @@ At Prem we are on a journey to make this possible, with a focus on developer exp

## Glossary

%TODO: define all these & use them where appropriate

```{glossary}
:sorted:
Foundation model
Evaluation
Auto-regressive language model
Decoder-style transformer
Tokens
[GPU](https://en.wikipedia.org/wiki/Graphics_processing_unit)
Graphics Processing Unit: hardware originally designed to accelerate computer image processing, but now often repurposed for [embarrassingly parallel](https://en.wikipedia.org/wiki/Embarrassingly_parallel) computational tasks in machine learning.
Graphics Processing Unit: hardware originally designed to accelerate computer image processing, but now often repurposed for [embarrassingly parallel](https://en.wikipedia.org/wiki/Embarrassingly_parallel) computational tasks in machine learning.
A100, V100, H100
Vector
Expand Down

0 comments on commit a6d4e91

Please sign in to comment.