├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── assets ├── citations_open_literature_note.png ├── editor_syntax_highlight.png ├── kanban.png ├── researcher.png └── technology_radar.png ├── researcher ├── books │ ├── Csikszentmihalyi (2008) – Flow.md │ └── Saini (2017) – Inferior.md ├── concepts │ ├── A concept.md │ ├── Backlog.md │ ├── Done.md │ ├── Kanban.md │ └── Priority.md ├── images │ └── panda.jpg ├── meta │ ├── Strategy.md │ ├── TIL.md │ └── Wins.md ├── people │ ├── Collaborator A.md │ ├── Collaborator B.md │ └── Supervisor.md ├── projects │ ├── Project A.md │ ├── Project B.md │ └── Project C │ │ ├── Another concept.md │ │ ├── Main concept.md │ │ └── Project C.md ├── scratch │ ├── 2020-05-24.md │ ├── 2020-05-25.md │ └── 2020-05-26.md └── tools │ └── The first tool.md ├── researcher_with_plugins ├── books │ ├── @butcher2016go.md │ └── @mcnamara2021rust.md ├── concepts │ ├── Concept.md │ ├── Golang.md │ ├── Project A CHANGELOG.md │ ├── Project A ROADMAP.md │ ├── Project A.md │ └── Rust.md ├── log │ └── 2021-03-14.md ├── people │ ├── Collaborator A.md │ ├── Collaborator B.md │ └── Supervisor.md ├── references.bib └── templates │ └── Daily.md └── technology_radar ├── Overview.md ├── Template.md └── content ├── Bento ML.md ├── Dgraph.md ├── Experiment Tracking.md ├── Feast.md ├── Feature Store.md ├── Graph Database.md ├── MLflow.md ├── Model Serving.md ├── Neo4j.md ├── Seldon Core.md ├── Tecton.md └── Weights & Biases.md /.gitignore: -------------------------------------------------------------------------------- 1 | .obsidian 2 | obsidian.css -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Obsidian Starter Templates 2 | 3 | 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 4 | 5 | ## How can I contribute? 6 | 7 | ### Example templates 8 | 9 | If you've discovered a useful way of working with Obsidian, consider creating a starter template and sharing with the community. We warmly welcome any pull requests. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Obsidian Starter Templates 2 | 3 | **Obsidian Starter Templates** is a reference for using [Obsidian](https://obsidian.md/). 4 | 5 | If you've tested out [Obsidian](https://obsidian.md/) and worked through the "Obsidian Help" folder, you might be looking for practical strategies to apply associative notes in your daily work. 6 | 7 | **Obsidian Starter Templates** gathers examples from the Obsidian [community](https://forum.obsidian.md/). Its broader aims are to uncover and communicate: 8 | 9 | 1. How others use backlinks and various markdown tricks, 10 | 2. Why these techniques work. 11 | 12 | The initial example covers how an academic researcher might choose to approach Obsidian. 13 | 14 | ## Getting started 15 | 16 | **Starter Templates** contains template vaults. To get started: 17 | 18 | 1. Clone the repository and open a vault folder in Obsidian using the "Open another vault" sidebar button. 19 | 20 | ## Contents 21 | 22 | * [Technology Radar](#Technology%20Radar): a template for tracking tools 23 | * [Researcher](#Researcher): general purpose template for research projects 24 | * [Researcher (with plugins)](#researcher-with-plugins): extended template using newer Obsidian community plugins 25 | 26 | ## Templates 27 | 28 | ### Technology Radar 29 | 30 | Technology Radars are a good way to review tools: for example, tools, techniques, languages, frameworks and platforms (Hewitt, 2019). See the [ThoughtWorks Technology Radar](https://www.thoughtworks.com/radar) for a comprehensive example. 31 | 32 | You can use Obsidian to track the tools that you're currently assessing and learning, noting down why they work for you. In this template, we use a YAML header of the form: 33 | 34 | ```yaml 35 | --- 36 | name: Tool 37 | site: https://tool.io/ 38 | status: one of [hold|assess|trial|adopt] 39 | topic: 40 | - machine learning 41 | - frontend 42 | - systems 43 | history: 44 | - 2021-03-14: adopt 45 | - 2021-03-07: assess 46 | --- 47 | 48 | Additional Markdown content. 49 | ``` 50 | 51 | The YAML header is useful if you want to parse your radar using additional scripting tools. The fields `status` and `history` can be used, for example, to track the progress of each tool through the radar. 52 | 53 | #### [Template.md](./technology_radar/Template.md) 54 | 55 | You can use a template file to make sure all of your entries are consistent. Adjust the template to your needs, for example by changing the list of topics to one more relevant to your project. 56 | 57 | #### [content/](./technology_radar/content) 58 | 59 | Use a flat folder structure, where all entries live within a single folder. 60 | 61 | #### [Overview.md](./technology_radar/Overview.md) 62 | 63 | The overview file is a Map of Content used to categorise the tools. 64 | 65 | This example has four additional Maps of Content ([Experiment Tracking](./technology_radar/Experiment%20Tracking.md), [Feature Store](./technology_radar/Feature%20Store.md), [Graph Database](./technology_radar/Graph%20Database.md) and [Model Serving](./technology_radar/Model%20Serving.md)). We can tag each Map of Content using `#moc` within the file so that they are easy to see in the graph visualisation: 66 | 67 | ![Technology radar graph view](./assets/technology_radar.png) 68 | 69 | In this example, `[[Machine Learning]]` is emerging as a highly linked node: suggesting that we could convert `[[Machine Learning]]` into its own Map of Content. 70 | 71 | **TIP:** Visualise the status of each tool using group queries in the graph view, for example `line:(status: trial)`. 72 | 73 | ### Researcher 74 | 75 | The [Researcher](./researcher) template suits a case where you are juggling multiple research projects: for example, reading several books and research papers simultaneously and maintaining multiple collaborations with other researchers. It's nice to have a starter template to experiment with ideas, even though backlinks and associative thinking encourage you to avoid hierarchies and rigid hierarchical structures: see for example Andy Matuschak's [evergreen notes](https://notes.andymatuschak.org/Evergreen_notes), [taxonomy of note types](https://notes.andymatuschak.org/Taxonomy_of_note_types) and [note-link-janitor](https://github.com/andymatuschak/note-link-janitor) project. 76 | 77 | #### Example network 78 | 79 | 80 | 81 | The template is intended to be modular. A minimal use could include [scratch/](https://github.com/masonlr/obsidian-starter-templates#scratch) and [concepts/](https://github.com/masonlr/obsidian-starter-templates#concepts), then later expand to [projects/](https://github.com/masonlr/obsidian-starter-templates#projects) and [people/](https://github.com/masonlr/obsidian-starter-templates#people). The intended structure is given by the following tree: 82 | 83 | #### [scratch/](./researcher/scratch/) 84 | 85 | The scratch folder is an area for messy, low-friction daily free-form planning and logging of ideas, i.e. [scratch/](./researcher/scratch/) will store content generated using the Obsidian "daily notes" feature. Daily notes can be created using the "Open today's note" action: this will create a new markdown file that follows the date-stamped name convention `YYYY-MM-DD.md`. 86 | 87 | **TIP:** Set a keyboard shortcut to quickly go to the day's note. For example, set `cmd+T` to "Open today's note" in the Hotkeys settings. 88 | **TIP:** Create a rigid layout for daily notes by specifying a template markdown file, though a blank template may encourage free-form thinking. 89 | 90 | After a few days, daily notes will build up as follows: 91 | 92 | - [2020-05-24.md](./researcher/scratch/2020-05-24.md) 93 | 94 | - [2020-05-25.md](./researcher/scratch/2020-05-25.md) 95 | 96 | - [2020-05-26.md](./researcher/scratch/2020-05-26.md) 97 | 98 | **TIP:** Keep a free-form record of what you're reading, doing and thinking about by linking to concepts and books: this way backlinks in each concept will show that dates on which work was done. Example in [2020-05-24.md](./researcher/scratch/2020-05-24.md): 99 | 100 | ```markdown 101 | Read about [[A concept]] in [[Saini (2017) – Inferior]] 102 | ``` 103 | 104 | When later reviewing [A concept.md](./researcher/concepts/A%20concept.md), backlinks will show that you were thinking about it on a particular date ([2020-05-24.md](./researcher/scratch/2020-05-24.md)). 105 | 106 | **TIP:** Use tags such as `#backlog` and `#priority` for simple Kanban-style task tracking, see [Distributed idea tracking](https://github.com/masonlr/obsidian-starter-templates#distributed-idea-tracking). 107 | 108 | #### [concepts/](./researcher/concepts/) 109 | 110 | Folder for "evergreen" concept notes (see Andy Matuschak's [evergreen notes](https://notes.andymatuschak.org/Evergreen_notes)). 111 | 112 | - [A concept.md](./researcher/concepts/A%20concept.md) 113 | 114 | An example concept note. 115 | 116 | **TIP:** In a link, it's clearer to read `[[A concept]]` than `[[a-concept]]`, so the filename uses white spaces here and sentence case. 117 | 118 | **TIP:** The filename is more important than the level-one heading. Use a filename appropriate for linking, but use a longer more descriptive level-one heading. Example in [A concept.md](./researcher/concepts/A%20concept.md) where the level-one heading is longer than the filename: 119 | 120 | ```markdown 121 | # A new concept that is useful 122 | ``` 123 | 124 | #### [projects/](./researcher/projects/) 125 | 126 | Link ideas, concepts and people to projects. 127 | 128 | - [Project A.md](./researcher/projects/Project%20A.md) 129 | 130 | **TIP:** Link to projects from daily notes to keep an informal record of progress. Example in [2020-05-24.md](./researcher/scratch/2020-05-24.md): 131 | 132 | ```markdown 133 | Got started on ideas about [[Main concept]] for [[Project C]]. 134 | ``` 135 | 136 | Project backlinks will then show dates that it was worked on. 137 | 138 | **TIP:** Add links to people and details of their involvement. Example in [Project A.md](./researcher/projects/Project%20A.md): 139 | 140 | ```markdown 141 | ## People 142 | 143 | - [[Supervisor]] 144 | - [[Collaborator A]] 145 | - [[Collaborator B]] might be interested. 146 | ``` 147 | 148 | - [Project B.md](./researcher/projects/Project%20B.md) 149 | 150 | - [Project C/](./researcher/projects/Project%20C/) 151 | 152 | If a project becomes more complex, it might turn into a folder with many attached concept notes. 153 | 154 | - [Project C.md](./researcher/projects/Project%20C/Project%20C.md) 155 | - [Main concept.md](./researcher/projects/Project%20C/Main%20concept.md) 156 | - [Another concept.md](./researcher/projects/Project%20C/Another%20concept.md) 157 | 158 | #### [people/](./researcher/people/) 159 | 160 | Keep track of interactions with collaborators. If you're doing a research project, you might also have a file for your adviser/supervisor. 161 | 162 | - [Collaborator A.md](./researcher/people/Collaborator%20A.md) 163 | - [Collaborator B.md](./researcher/people/Collaborator%20B.md) 164 | - [Supervisor.md](./researcher/people/Supervisor.md) 165 | 166 | **TIP:** Link to a person from anywhere if there is an association. You could link from a concept. Example in [A concept.md](./researcher/concepts/A%20concept.md) links to a person from a concept: 167 | 168 | ```markdown 169 | [[Collaborator A]] has a good idea about this, but [[Supervisor]] thinks that this is wrong. 170 | ``` 171 | 172 | **TIP:** To keep a record of interactions you could link from the daily log. Example in [2020-05-25.md](./researcher/scratch/2020-05-25.md) links from a potential task to a person: 173 | 174 | ``` 175 | #priority Meet with [[Collaborator B]] to discuss ideas. 176 | ``` 177 | 178 | #### [books/](./researcher/books/) 179 | 180 | Keep a record of important books here. Each book page could link to a set of relevant concept notes, rather than containing content. If you're undertaking a research project, you could also add an `articles/` folder. 181 | 182 | - [Csikszentmihalyi – Flow.md](<./researcher/books/Csikszentmihalyi%20(2008)%20%E2%80%93%20Flow.md>) 183 | 184 | **TIP:** Link to concept pages rather than writing directly in a book page (see Andy Matuschak's [taxonomy of note types](https://notes.andymatuschak.org/Taxonomy_of_note_types)). Example in [Csikszentmihalyi – Flow.md](<./researcher/books/Csikszentmihalyi%20(2008)%20%E2%80%93%20Flow.md>) links from a book to a concept: 185 | 186 | ```markdown 187 | - One of the chapters focused on [[A concept]] 188 | ``` 189 | 190 | **TIP:** Link from concept pages to book pages. Example in [A concept.md](./researcher/concepts/A%20concept.md): 191 | 192 | ```markdown 193 | - [[Saini (2017) – Inferior]] described it like this, but [[Csikszentmihalyi (2008) – Flow]] described it like that. 194 | ``` 195 | 196 | - [Saini – Inferior.md](<./researcher/books/Saini%20(2017)%20%E2%80%93%20Inferior.md>) 197 | 198 | **TIP:** Link from PDF pages to book pages: 199 | 200 | ```markdown 201 | - [[Saini (2017) - Inferior.pdf#page=40]] described it. 202 | ``` 203 | 204 | #### [tools/](./researcher/tools/) 205 | 206 | Think about the tools you're currently using, search for new tools, write notes about what you've learnt. 207 | 208 | - [The first tool.md](./researcher/tools/The%20first%20tool.md) 209 | 210 | #### [meta/](./researcher/meta/) 211 | 212 | Question your approaches here and keep a record of insights and meta concepts. 213 | 214 | - [TIL.md](./researcher/TIL.md) 215 | 216 | Use to record today-I-learned ([TIL](https://dictionary.cambridge.org/dictionary/english/til)) style ideas. Example in [2020-05-26.md](./researcher/scratch/2020-05-26.md) links two concepts: 217 | 218 | ```markdown 219 | [[TIL]] Some interesting idea that stood out. It changed how I thought about [[A concept]] in relation to [[Another concept]]. 220 | ``` 221 | 222 | **TIP:** Backlinks to [TIL.md](./researcher/TIL.md) will show a record of when concepts were learnt. 223 | 224 | - [Strategy.md](./researcher/meta/Strategy.md) 225 | 226 | - [Wins.md](./researcher/meta/Wins.md) 227 | 228 | **TIP:** Keep a record of any milestones or positive feedback. 229 | 230 | #### [images/](./researcher/images/) 231 | 232 | (optional) You can set a dedicated folder to handle all image uploads: the folder will hold a copy of all images dragged onto Obsidian notes. 233 | 234 | - [panda.jpg](./researcher/images/panda.jpg) 235 | 236 | **TIP:** When renaming an image, all links to it will be automatically updated. 237 | 238 | #### Distributed idea tracking 239 | 240 | Rather than maintaining a list of tasks, distribute the tags across all files so that tags are placed alongside content. Tags can be used to replace simple Kanban-style task tracking. Use whatever tag system works for you – an example idea tags could include: 241 | 242 | - `#next`: Must be done next. 243 | 244 | **TIP:** Limit to 2 or 3 instances for a work-in-progress limit. 245 | 246 | - `#backlog`: Should be done in the future. 247 | 248 | - `#priority`: Should be done soon. 249 | 250 | - `#irk`: Must be done soon, but annoying or getting in the way. 251 | 252 | - `#lateral`: Interesting left-field idea that may or may not lead anywhere. High-risk, high-reward. 253 | 254 | - `#question`: Something uncertain. Plays the role of Wikipedia's [citation needed](https://en.wikipedia.org/wiki/Wikipedia:Citation_needed). 255 | 256 | Once an idea has been explored or a task has been finished, delete the tag or add 257 | 258 | - `#done`: Done 259 | 260 | #### Kanban with embeded queries: 261 | 262 | ```markdown 263 | | | | | 264 | | ------------ | --------------- | --------- | 265 | | ![[Backlog]] | ![[Priority]] | ![[Done]] | 266 | ``` 267 | 268 | Example in `Backlog.md`: 269 | 270 | ```markdown 271 | ​```query 272 | tag:backlog 273 | ​``` 274 | ``` 275 | 276 | ![Example Kanban board](./assets/kanban.png) 277 | 278 | #### Task lists 279 | 280 | [Markdown task lists](https://help.github.com/en/github/managing-your-work-on-github/about-task-lists) work well in WYSIWYG editors such as [Typora](https://typora.io/). WYSIWYG editing is on the [Obsidian roadmap](https://trello.com/b/Psqfqp7I/obsidian-roadmap), so may well become a better option than a tag based system. 281 | 282 | #### Referencing 283 | 284 | For one-off references, pasted links work fine. Example in [A concept.md](./researcher/concepts/A%20concept.md): 285 | 286 | ```markdown 287 | This concept only appeared once, so just paste link. 288 | https://en.wikipedia.org/wiki/Mental_state 289 | ``` 290 | 291 | If a link occurs multiple times, it might be appropriate to use markdown footnotes and gather a reference list. Example in [A concept.md](./researcher/concepts/A%20concept.md): 292 | 293 | ```markdown 294 | This link appears many times,[^repeated] so maybe use a footnote. 295 | A reference[^repeated] had an even different idea to [[Csikszentmihalyi (2008) – Flow]]. 296 | 297 | [[Collaborator A]] has a good idea about this, but [[Supervisor]] thinks that this is wrong. I need to check.[^repeated] 298 | 299 | ## References 300 | 301 | [^repeated]: Flow (psychology): https://en.wikipedia.org/wiki/Flow_(psychology) 302 | ``` 303 | 304 | 305 | ### Researcher (with plugins) 306 | 307 | Since the original [Researcher](#Researcher) template was posted there have been updates to Obsidian, including many community plugins. [Researcher (with plugins)](./researcher_with_plugins) captures several newer ideas and can be viewed as an advanced version of the original [Researcher](#Researcher) template. 308 | 309 | #### Maps of Content 310 | 311 | A blend of Maps of Content, roadmaps and changelogs is effective for organising multiple projects. 312 | 313 | For example: 314 | 315 | ##### [concepts/](./researcher_with_plugins/concepts/) 316 | 317 | Keep one flat structure for all evergreen concept notes. 318 | 319 | * [Concept.md](./researcher_with_plugins/concepts/Concept.md) 320 | 321 | An example concept note. 322 | 323 | * [Project A](./researcher_with_plugins/concepts/Project%20A.md) 324 | 325 | An example map of content (see [In what ways can we form useful relationships between notes](https://forum.obsidian.md/t/in-what-ways-can-we-form-useful-relationships-between-notes-long-read/702)) for summarising a project. 326 | 327 | **TIP:** If you have multiple projects create additional maps of content, for example Project B and Project C (use more meaningful names though). Keep a flat structure rather than creating dedicated folders for each project. 328 | 329 | * [Project A CHANGELOG](./researcher_with_plugins/concepts/Project%20A%20CHANGELOG.md) 330 | 331 | Keep a rough changelog of important completed tasks in your project – many open-source projects use a `CHANGELOG.md` file (see for example [Keep a Changelog](https://keepachangelog.com/)). 332 | 333 | * [Project A ROADMAP](./researcher_with_plugins/concepts/Project%20A%20ROADMAP.md) 334 | 335 | Keep a rough sketch of future ideas and plans using a roadmap – many open-source projects use a `ROADMAP.md` (for ideas, check out Mozilla's [Introduction to Roadmapping](https://mozillascience.github.io/working-open-workshop/roadmapping/)). 336 | 337 | #### Referencing 338 | 339 | ##### [references.bib](./researcher_with_plugins/references.bib) 340 | 341 | The [Citations](https://github.com/hans/obsidian-citation-plugin) community plugin is great for referencing. If you maintain a list of references in `.bib` format (for example using [Zotero](https://www.zotero.org/) or [BibDesk](https://bibdesk.sourceforge.io/)), you can search references from within Obsidian and, if needed, create a dedicated page for each reference. 342 | 343 | **TIP:** You can create a dedicated page for each reference via "Citations: Open literature note" in the Obsidian command palette – create a dedicated Hotkey for this action if you use it often. 344 | 345 | ![Citations: Open literature note](./assets/citations_open_literature_note.png) 346 | 347 | 348 | 349 | You can write short notes (for example, short chapter summaries) on each reference page itself (see [@butcher2016go.md](./researcher_with_plugins/books/@butcher2016go.md)). It can be useful to write longer notes on specific concepts elsewhere, and refer back to the source using Markdown citations: `[[@butcher2016go]`. 350 | 351 | **TIP:** You can create a citations using "Citations: Insert Markdown citation" in the Obsidian command palette – create a dedicated Hotkey for this action if you use it often. 352 | 353 | #### Backups 354 | 355 | Use [Obsidian Git](https://github.com/denolehov/obsidian-git) to configure automatic backups to a remote git repository (e.g. GitHub or GitLab). 356 | 357 | #### Templating 358 | 359 | ##### [templates/](./researcher_v2/templates) 360 | 361 | * [Daily.md](./researcher_v2/templates/Daily.md) 362 | 363 | The [Templater](https://github.com/SilentVoid13/Templater) community plugin allows you to create custom daily notes. In this simple example, we have links to yesterday and tomorrow (these links allow you to flick quickly between days when reviewing notes): 364 | 365 | ```markdown 366 | 📆 [[{{tp_yesterday}}]] – [[{{tp_tomorrow}}]] 367 | ``` 368 | #### Syntax highlighting 369 | 370 | [Editor Syntax Highlight](https://github.com/deathau/cm-editor-syntax-highlight-obsidian) enables syntax highlighting while in editor mode: 371 | 372 | ![Editor syntax highlighting](./assets/editor_syntax_highlight.png) 373 | 374 | 375 | ## References 376 | 377 | - Hewitt, E, 2019. Technology Strategy Patterns. O'Reilly Media. 378 | - Obsidian: https://obsidian.md/ 379 | - Matuschak, A. Evergreen notes: https://notes.andymatuschak.org/Evergreen_notes 380 | - Matuschak, A. Note-link Janitor: https://github.com/andymatuschak/note-link-janitor 381 | - Matuschak, A. Taxonomy of note types: https://notes.andymatuschak.org/Taxonomy_of_note_types 382 | -------------------------------------------------------------------------------- /assets/citations_open_literature_note.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/masonlr/obsidian-starter-templates/cf66e8a1aa5b6a6c605744258c7797ca72194b3d/assets/citations_open_literature_note.png -------------------------------------------------------------------------------- /assets/editor_syntax_highlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/masonlr/obsidian-starter-templates/cf66e8a1aa5b6a6c605744258c7797ca72194b3d/assets/editor_syntax_highlight.png -------------------------------------------------------------------------------- /assets/kanban.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/masonlr/obsidian-starter-templates/cf66e8a1aa5b6a6c605744258c7797ca72194b3d/assets/kanban.png -------------------------------------------------------------------------------- /assets/researcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/masonlr/obsidian-starter-templates/cf66e8a1aa5b6a6c605744258c7797ca72194b3d/assets/researcher.png -------------------------------------------------------------------------------- /assets/technology_radar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/masonlr/obsidian-starter-templates/cf66e8a1aa5b6a6c605744258c7797ca72194b3d/assets/technology_radar.png -------------------------------------------------------------------------------- /researcher/books/Csikszentmihalyi (2008) – Flow.md: -------------------------------------------------------------------------------- 1 | # Csikszentmihalyi – Flow 2 | Csikszentmihalyi, M. (2008) Flow: The Psychology of Optimal Experience. 3 | 4 | --- 5 | 6 | - One of the chapters focused on [[A concept]] 7 | - Not sure what the point of this is. #question -------------------------------------------------------------------------------- /researcher/books/Saini (2017) – Inferior.md: -------------------------------------------------------------------------------- 1 | # Saini – Inferior 2 | 3 | Saini, A. (2017). Inferior. 4 | 5 | --- 6 | 7 | - [[A concept]] came from this -------------------------------------------------------------------------------- /researcher/concepts/A concept.md: -------------------------------------------------------------------------------- 1 | # A new useful concept 2 | - [[Saini (2017) – Inferior]] described it like this, but [[Csikszentmihalyi (2008) – Flow]] described it like that. 3 | 4 | ## More detail 5 | This link appears many times,[^repeated] so uses a footnote. A reference[^repeated] had an even different idea to [[Csikszentmihalyi (2008) – Flow]]. 6 | 7 | This concept only appeared once, so just paste link. 8 | https://en.wikipedia.org/wiki/Mental_state 9 | 10 | [[Collaborator A]] has a good idea about this, but [[Supervisor]] thinks that this is wrong. I need to check.[^repeated] 11 | 12 | ## References 13 | [^repeated]: Flow (psychology): https://en.wikipedia.org/wiki/Flow_(psychology) -------------------------------------------------------------------------------- /researcher/concepts/Backlog.md: -------------------------------------------------------------------------------- 1 | ```query 2 | tag:backlog 3 | ``` -------------------------------------------------------------------------------- /researcher/concepts/Done.md: -------------------------------------------------------------------------------- 1 | ```query 2 | tag:done 3 | ``` -------------------------------------------------------------------------------- /researcher/concepts/Kanban.md: -------------------------------------------------------------------------------- 1 | | | | | 2 | | ------------ | --------------- | --------- | 3 | | ![[Backlog]] | ![[Priority]] | ![[Done]] | -------------------------------------------------------------------------------- /researcher/concepts/Priority.md: -------------------------------------------------------------------------------- 1 | ```query 2 | tag:priority 3 | ``` -------------------------------------------------------------------------------- /researcher/images/panda.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/masonlr/obsidian-starter-templates/cf66e8a1aa5b6a6c605744258c7797ca72194b3d/researcher/images/panda.jpg -------------------------------------------------------------------------------- /researcher/meta/Strategy.md: -------------------------------------------------------------------------------- 1 | # Strategy 2 | Constantly question your approaches here and keep a record of insights and meta concepts. 3 | 4 | > Don't over-obsess or over-formalize this stuff. Remember: "Better note-taking" misses the point; what matters is "better thinking". 5 | > — Andy Matuschak Look at backlinks to find the content. 5 | -------------------------------------------------------------------------------- /researcher/meta/Wins.md: -------------------------------------------------------------------------------- 1 | # Wins 2 | Keep a record of any positive feedback by linking to [[Wins]]. 3 | 4 | > Look at backlinks to find the content. -------------------------------------------------------------------------------- /researcher/people/Collaborator A.md: -------------------------------------------------------------------------------- 1 | # Collaborator A 2 | Add any short notes here. -------------------------------------------------------------------------------- /researcher/people/Collaborator B.md: -------------------------------------------------------------------------------- 1 | # Collaborator B 2 | Add any short notes here. -------------------------------------------------------------------------------- /researcher/people/Supervisor.md: -------------------------------------------------------------------------------- 1 | # Supervisor 2 | Add any short notes here. 3 | 4 | ![[panda.jpg]] -------------------------------------------------------------------------------- /researcher/projects/Project A.md: -------------------------------------------------------------------------------- 1 | # Project A 2 | Project A started out as a single notes (like the otheres) but grew into its own folder of concepts. 3 | 4 | ## People 5 | - [[Supervisor]] 6 | - [[Collaborator A]] 7 | - [[Collaborator B]] might be interested. 8 | 9 | ## Ideas 10 | We're going to expand on [[Main concept]] and show how it relates to [[A concept]]. -------------------------------------------------------------------------------- /researcher/projects/Project B.md: -------------------------------------------------------------------------------- 1 | # Project B 2 | A project description will need to go here. 3 | 4 | ## People 5 | - [[Supervisor]] 6 | - [[Collaborator B]] -------------------------------------------------------------------------------- /researcher/projects/Project C/Another concept.md: -------------------------------------------------------------------------------- 1 | # Another concept -------------------------------------------------------------------------------- /researcher/projects/Project C/Main concept.md: -------------------------------------------------------------------------------- 1 | # A main concept -------------------------------------------------------------------------------- /researcher/projects/Project C/Project C.md: -------------------------------------------------------------------------------- 1 | # Project C 2 | A project description will need to go here. 3 | 4 | ## People 5 | - [[Supervisor]] 6 | -------------------------------------------------------------------------------- /researcher/scratch/2020-05-24.md: -------------------------------------------------------------------------------- 1 | ## Plans 2 | Get some reading done. 3 | 4 | --- 5 | 6 | Got started on [[Main concept]] for [[Project C]]. 7 | 8 | ## Ideas 9 | #idea Talk to [[Collaborator B]] about this. 10 | 11 | #done Read about [[A concept]] in [[Saini (2017) – Inferior]]. 12 | 13 | ~~An idea that you gave up on pursuing.~~ Reason why. 14 | 15 | -------------------------------------------------------------------------------- /researcher/scratch/2020-05-25.md: -------------------------------------------------------------------------------- 1 | ## Plans 2 | #priority Meet with [[Collaborator B]] to discuss ideas. 3 | 4 | --- 5 | 6 | #next #backlog Get something done for [[Collaborator B]]. 7 | 8 | #irk Something I have to do with urgency, but don't really want to. 9 | 10 | [[Wins]] Finally workout why [[Supervisor]] thinks constantly about [[Another concept]]. -------------------------------------------------------------------------------- /researcher/scratch/2020-05-26.md: -------------------------------------------------------------------------------- 1 | ## Plans 2 | Get started on [[Project C]]. 3 | 4 | --- 5 | 6 | ## Ideas 7 | #backlog Think about how [[Another concept]] relates to [[Main concept]]. 8 | 9 | #lateral This is a tangent idea, but might lead to something. 10 | 11 | [[TIL]] Some interesting idea that stood out. It changed how I thought about [[A concept]] in relation to [[Another concept]]. -------------------------------------------------------------------------------- /researcher/tools/The first tool.md: -------------------------------------------------------------------------------- 1 | # The first tool 2 | Write notes here about a tool or technique. 3 | 4 | If #the-tool is mentioned in passing in other notes, you could use tag (for example #the-tool ). 5 | 6 | If the association is stronger, you could use a link to [[The first tool]]. 7 | 8 | ![[panda.jpg]] -------------------------------------------------------------------------------- /researcher_with_plugins/books/@butcher2016go.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Go in practice 3 | authors: Matt Butcher, Matt Farina 4 | year: 2016 5 | --- 6 | 7 | # Go in practice 8 | 9 | Summary of the book chapters could go here. Write notes on particular concepts elsewhere and refer back to this page using [@butcher2016go]. 10 | 11 | You can add citations using "Citations: Insert Markdown citation" in the Obsidian command pallete. -------------------------------------------------------------------------------- /researcher_with_plugins/books/@mcnamara2021rust.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Rust in Action 3 | authors: Tim McNamara 4 | year: 2021 5 | --- 6 | 7 | -------------------------------------------------------------------------------- /researcher_with_plugins/concepts/Concept.md: -------------------------------------------------------------------------------- 1 | # An example concept note 2 | 3 | This page might explore an import concept using ideas from multiple references: for example, [[@butcher2016go]] may recommend Golang for everything, while [[@mcnamara2021rust]] may recommend Rust. 4 | 5 | You can highlight that this concept is relevant for specific projects such as [[Project A]]. -------------------------------------------------------------------------------- /researcher_with_plugins/concepts/Golang.md: -------------------------------------------------------------------------------- 1 | # Golang 2 | 3 | Here I'm working on an example concept from [[@butcher2016go]]: 4 | 5 | ```go 6 | package main 7 | 8 | import "fmt" 9 | 10 | func main() { 11 | fmt.Println("Hello from go") 12 | } 13 | ``` -------------------------------------------------------------------------------- /researcher_with_plugins/concepts/Project A CHANGELOG.md: -------------------------------------------------------------------------------- 1 | [[Project A]] 2 | # Project A CHANGELOG 3 | Many open source projects have a changelog for tracking project history – this typically exists as a local `CHANGELOG.md` file. 4 | 5 | You can track history for [[Project A]] is this changelog here. 6 | 7 | ## Phase 2: If you're using phases 8 | - [ ] More new ideas go here 9 | 10 | ## Phase 1 11 | - [ ] Feature Three: Still working on this 12 | - [x] Feature Two: Got this one done 13 | - [x] Sub-Feature A: Explanation can goe here 14 | - [x] Feature One: Free-form text goes here 15 | - [x] Work out whether we should use [[Golang]] or [[Rust]] -------------------------------------------------------------------------------- /researcher_with_plugins/concepts/Project A ROADMAP.md: -------------------------------------------------------------------------------- 1 | [[Project A]] 2 | # Project A ROADMAP 3 | Many open source projects have a roadmap for planning and prioritising future features – this typically exists as a local `ROADMAP.md` file. 4 | 5 | If you want to apply roadmap-like thinking to your project, create a dedicated road map file and use Markdown checkboxes to track progress. 6 | 7 | - [x] Feature Four: Have finished this one, so will move this text to the [[Project A ROADMAP]] when I get a chance. 8 | - [ ] Feature Five: Want to get this done 9 | - [ ] ~~An idea that we've given up on~~ Reason why goes here. 10 | - [ ] Get better at [[Rust]] -------------------------------------------------------------------------------- /researcher_with_plugins/concepts/Project A.md: -------------------------------------------------------------------------------- 1 | # Project A 2 | 3 | This page is a Map of Content (see [In what ways can we form useful relationships between notes \[LONG READ\]](https://forum.obsidian.md/t/in-what-ways-can-we-form-useful-relationships-between-notes-long-read/702)) for [[Project A]]. 4 | 5 | You can use this Map of Content for different purposes such as summarising who is involved with this project: such as [[Supervisor]] and [[Collaborator A]]. 6 | 7 | ## Concepts: 8 | 9 | Maybe you have a sentence explaining why [[Concept]] is important for [[Project A]]. 10 | 11 | ## References: 12 | 13 | You could list brief opinions regarding the key references of [[Project A]] such as [[@butcher2016go]] and [[@mcnamara2021rust]]. 14 | 15 | ## Trackers: 16 | 17 | [[Project A]] has two trackers: 18 | - [[Project A ROADMAP]] for planning the future 19 | - [[Project A CHANGELOG]] for reflecting on the past -------------------------------------------------------------------------------- /researcher_with_plugins/concepts/Rust.md: -------------------------------------------------------------------------------- 1 | # Rust 2 | 3 | Here I'm working on example concept from [[@mcnamara2021rust]]: 4 | 5 | ```rust 6 | fn main() { 7 | println!("Hello from rust"); 8 | } 9 | ``` -------------------------------------------------------------------------------- /researcher_with_plugins/log/2021-03-14.md: -------------------------------------------------------------------------------- 1 | 2 | 📆 [[2021-03-13]] – [[2021-03-15]] 3 | 4 | This is a daily note for sketching out what you're working on *right now*. I 5 | 6 | Once way to planning what to do is to use a question-and-answer style: 7 | 8 | --- 9 | 10 | *Q: How do we get something done?* 11 | 12 | A: Explanation of answer, once you've figured it out. 13 | 14 | --- 15 | 16 | Another way is to use nested checkboxes: 17 | 18 | - [ ] First question that I need to figure out today 19 | 20 | > Answer to first question 21 | 22 | - [x] Second related question that came up while I was thinking about question one 23 | 24 | > Another answer that I thought of 25 | 26 | --- 27 | 28 | You can include events such as meetings: 29 | 30 | Met with [[Collaborator A]] and discussed [[Project A]]. 31 | 32 | 33 | [[TIL]] [[Rust]] and [[Golang]] are complementary: https://thenewstack.io/rust-vs-go-why-theyre-better-together/ -------------------------------------------------------------------------------- /researcher_with_plugins/people/Collaborator A.md: -------------------------------------------------------------------------------- 1 | # Collaborator A 2 | Add any short notes here. -------------------------------------------------------------------------------- /researcher_with_plugins/people/Collaborator B.md: -------------------------------------------------------------------------------- 1 | # Collaborator B 2 | Add any short notes here. -------------------------------------------------------------------------------- /researcher_with_plugins/people/Supervisor.md: -------------------------------------------------------------------------------- 1 | # Supervisor 2 | Add any short notes here. -------------------------------------------------------------------------------- /researcher_with_plugins/references.bib: -------------------------------------------------------------------------------- 1 | 2 | @book{butcher2016go, 3 | title = {Go in {Practice}}, 4 | author = {Butcher, Matt and Farina, Matt}, 5 | date = {2016}, 6 | publisher = {{Manning Publications Co}}, 7 | location = {{Shelter Island, NY}}, 8 | annotation = {OCLC: ocn913335043}, 9 | isbn = {978-1-63343-007-5}, 10 | keywords = {Go (Computer program language)}, 11 | langid = {english}, 12 | pagetotal = {287} 13 | } 14 | 15 | @book{mcnamara2021rust, 16 | title = {Rust in {Action}}, 17 | author = {McNamara, Tim}, 18 | date = {2021}, 19 | publisher = {{Manning Publications}} 20 | } -------------------------------------------------------------------------------- /researcher_with_plugins/templates/Daily.md: -------------------------------------------------------------------------------- 1 | 📆 [[{{tp_yesterday}}]] – [[{{tp_tomorrow}}]] 2 | 3 | You can now have templated daily notes using the [Templater](https://github.com/SilentVoid13/Templater) plugin. This example will put links to yesterday's and tomorrow's notes at the top of the daily note. -------------------------------------------------------------------------------- /technology_radar/Overview.md: -------------------------------------------------------------------------------- 1 | #moc 2 | 3 | # Overview 4 | 5 | This page is a Map of Content. Use whichever categories make the most sense to you. For example, we could group by general themes, where each them is also a Map of Content. 6 | 7 | ## Machine Learning 8 | [[Experiment Tracking]] 9 | [[Model Serving]] 10 | [[Feature Store]] 11 | 12 | ## Data Storage 13 | [[Graph Database]] -------------------------------------------------------------------------------- /technology_radar/Template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Tool 3 | site: https://tool.io/ 4 | status: [hold|assess|trial|adopt] 5 | topic: 6 | - machine learning 7 | - frontend 8 | - systems 9 | history: 10 | - 2021-03-14: adopt 11 | --- 12 | 13 | # Tool 14 | Brief description of the tool. 15 | 16 | ## Reasoning for 17 | 18 | ## Reasoning against 19 | 20 | ## Alternatives considered 21 | 22 | ## Resources 23 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Bento ML.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bento ML 3 | site: https://github.com/bentoml/BentoML 4 | status: assess 5 | topic: 6 | - machine learning 7 | - systems 8 | history: 9 | - 2021-03-14: assess 10 | --- 11 | 12 | # Bento ML 13 | 14 | [[Bento ML]] is a framework for deploying [[Machine Learning]] models – it enables [[Model Serving]]. 15 | 16 | ## Reasoning for 17 | 1. Open source 18 | 2. ... 19 | 20 | ## Reasoning against 21 | 22 | ## Alternatives considered 23 | 1. [[Seldon Core]] 24 | 25 | ## Resources 26 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Dgraph.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Dgraph 3 | site: https://dgraph.io/ 4 | status: adopt 5 | topic: 6 | - systems 7 | history: 8 | - 2021-03-14: adopt 9 | - 2021-03-07: assess 10 | --- 11 | 12 | # Dgraph 13 | [[Dgraph]] is a [[Graph Database]]. 14 | 15 | ## Reasoning for 16 | 1. Open source. 17 | 2. ... 18 | ## Reasoning against 19 | 1. ... 20 | 21 | ## Resources 22 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Experiment Tracking.md: -------------------------------------------------------------------------------- 1 | #moc 2 | 3 | # Experiment Tracking 4 | 5 | Here you can summarise what [[Experiment Tracking]] actually is and summarise some of the tools that have been considered. 6 | 7 | We may give a quick summary of [[MLflow]] and what makes it different to [[Weights & Biases]]. 8 | 9 | There's no need to list all of the [[Experiment Tracking]] tools considered as we can rely on backlinks to [[Experiment Tracking]] to do that for us. -------------------------------------------------------------------------------- /technology_radar/content/Feast.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feast 3 | site: https://feast.dev/ 4 | status: trial 5 | topic: 6 | - machine learning 7 | - systems 8 | history: 9 | - 2021-03-14: trial 10 | - 2021-03-07: assess 11 | --- 12 | 13 | # Feast 14 | [[Feast]] is a [[Feature Store]] for [[Machine Learning]]. 15 | 16 | 17 | ## Reasoning for 18 | 1. Open source 19 | 20 | ## Reasoning against 21 | 1. ... 22 | 23 | ## Alternatives considered 24 | 1. [[Tecton]] 25 | 26 | ## Resources 27 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Feature Store.md: -------------------------------------------------------------------------------- 1 | #moc 2 | 3 | # Feature Store 4 | 5 | Here you can summarise what [[Feature Store]] actually are and go on to summarise some of the tools that have been considered. 6 | 7 | We may give a quick summary of [[Feast]] and what makes it different to [[Tecton]]. 8 | 9 | There's no need to list off the [[Feature Store]] tools considered as we can rely on backlinks to [[Feature Store]] to do that for us. -------------------------------------------------------------------------------- /technology_radar/content/Graph Database.md: -------------------------------------------------------------------------------- 1 | #moc 2 | 3 | # Graph Database 4 | 5 | Here you can summarise what [[Graph Database]] actually are and go on to summarise some of the tools that have been considered. 6 | 7 | We may give a quick summary of [[Dgraph]] and what makes it different to [[Neo4j]]. 8 | 9 | There's no need to list all the [[Graph Database]] considered as we can rely on backlinks to [[Model Serving]] to do that for us. -------------------------------------------------------------------------------- /technology_radar/content/MLflow.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: MLflow 3 | site: https://www.mlflow.org/ 4 | status: adopt 5 | topic: 6 | - machine learning 7 | history: 8 | - 2020-03-14: adopt 9 | --- 10 | 11 | # MLflow 12 | MLflow is an [[Experiment Tracking]] framework for [[Machine Learning]]. 13 | 14 | ## Reasoning for 15 | 1. Open source 16 | 2. ... 17 | 18 | ## Reasoning against 19 | 20 | ## Alternatives considered 21 | 1. [[Weights & Biases]] 22 | 23 | ## Resources 24 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Model Serving.md: -------------------------------------------------------------------------------- 1 | #moc 2 | 3 | # Model Serving 4 | 5 | Here you can summarise what [[Model Serving]] actually is and go on to summarise some of the tools that have been considered. 6 | 7 | We may give a quick summary of [[Seldon Core]] and what makes it different to [[Bento ML]]. 8 | 9 | There's no need to list all of the [[Model Serving]] tools considered as we can rely on backlinks to [[Model Serving]] to do that for us. -------------------------------------------------------------------------------- /technology_radar/content/Neo4j.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Neo4j 3 | site: https://neo4j.com/ 4 | status: assess 5 | topic: 6 | - systems 7 | history: 8 | - 2021-03-14: assess 9 | --- 10 | 11 | # Tool 12 | [[Neo4j]] is a [[Graph Database]]. 13 | 14 | ## Reasoning for 15 | 1. ... 16 | 17 | ## Reasoning against 18 | 1. ... 19 | 20 | ## Resources 21 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Seldon Core.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Seldon Core 3 | site: https://github.com/SeldonIO/seldon-core 4 | status: adopt 5 | topic: 6 | - machine learning 7 | - systems 8 | history: 9 | - 2021-03-14: adopt 10 | - 2021-02-12: assess 11 | --- 12 | 13 | # Seldon Core 14 | 15 | [[Seldon Core]] is a Kubernetes framework for deploying [[Machine Learning]] models – it enables [[Model Serving]]. 16 | 17 | ## Reasoning for 18 | 1. Open source 19 | 2. ... 20 | 21 | ## Reasoning against 22 | 23 | ## Alternatives considered 24 | 1. [[Bento ML]] 25 | 26 | ## Resources 27 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Tecton.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Tecton 3 | site: https://www.tecton.ai/ 4 | status: assess 5 | topic: 6 | - machine learning 7 | - systems 8 | history: 9 | - 2021-03-14: assess 10 | --- 11 | 12 | # Tecton 13 | [[Tecton]] is a [[Feature Store]] for [[Machine Learning]]. 14 | 15 | 16 | ## Reasoning for 17 | 1. ... 18 | 19 | ## Reasoning against 20 | 1. ... 21 | 22 | ## Alternatives considered 23 | 1. [[Feast]] 24 | 25 | ## Resources 26 | Link to relevant blog posts here. -------------------------------------------------------------------------------- /technology_radar/content/Weights & Biases.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Weights & Biases 3 | site: https://wandb.ai/site 4 | status: assess 5 | topic: 6 | - machine learning 7 | history: 8 | - 2021-03-14: assess 9 | --- 10 | 11 | # Weights & Biases 12 | MLflow is an [[Experiment Tracking]] framework for [[Machine Learning]]. 13 | 14 | ## Reasoning for 15 | 1. ... 16 | 17 | ## Reasoning against 18 | 19 | 1. ... 20 | 21 | ## Alternatives considered 22 | 1. [[MLflow]] 23 | 24 | ## Resources 25 | Link to relevant blog posts here. --------------------------------------------------------------------------------