Skip to content

Commit a6d4e91

Browse files
committed
contrib: more content guidance
1 parent 0fbca28 commit a6d4e91

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

.github/pull_request_template.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44
55
- [ ] chapter content
66
+ [ ] only one top-level `# h1-Title`
7-
+ [ ] summary (e.g. table), no need for an explicit `## Summary/Introduction` title or equivalent
7+
+ [ ] summary (e.g. table or TL;DR overview), no need for an explicit `## Summary/Introduction` title or equivalent
88
+ [ ] main content focus: recent developments in open source AI
9+
+ general context/background (brief)
10+
+ current pros/cons
11+
+ in-depth insights (not yet widely known)
912
+ [ ] likely `## Future` developments
1013
+ [ ] end with `{{ comments }}`
1114
- [ ] appropriate citations

index.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,11 @@ Don't worry about making it perfect, it's fine to open a (`draft <https://docs.g
9696
+ please use https://github.com/premAI-io/static.premai.io to host images & data
9797

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

102+
% comment lines (not rendered) are prefixed with a "%"
103+
101104
### Contributors
102105

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

119122
## Glossary
120123

124+
%TODO: define all these & use them where appropriate
125+
121126
```{glossary}
122127
:sorted:
128+
Foundation model
123129
Evaluation
124130
Auto-regressive language model
125131
Decoder-style transformer
126132
Tokens
127133
[GPU](https://en.wikipedia.org/wiki/Graphics_processing_unit)
128-
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.
134+
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.
129135
130136
A100, V100, H100
131137
Vector

0 commit comments

Comments
 (0)