Initial commit

.JuliaFormatter.toml

@@ -0,0 +1,2 @@
+indent = 2
+format_docstrings = true

.github/workflows/mkdocs.yml

@@ -0,0 +1,22 @@
+name: mkdocs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
+

.gitignore

@@ -0,0 +1,3 @@
+# Python env
+env/
+.venv/

README.md

@@ -0,0 +1,33 @@
+# Pumas-AI Workshop Templates
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+## How to use this template
+
+1. Click on the green button `Use this template`
+1. Edit all the `PLACEHOLDER` in `mkdocs.yml` with respect to `site_name`, `repo_name` and `repo_url`.
+1. Edit all the `PLACEHOLDER` in `docs/index.md`, `docs/reference.md` and `docs/instructor.md`.
+1. Add appropriate content to `docs/index.md`, `docs/reference.md` and `docs/instructor.md`.
+
+## How to contribute
+
+We use [Material for MkDocs](https://github.com/squidfunk/mkdocs-material)
+(MIT License) as the static site generator.
+
+1. Clone the repository
+1. Install Material for MkDocs with `pip install mkdocs-material`
+1. Create or review content
+1. Preview the site with `mkdocs serve`
+1. Make a Pull Request
+
+## Authors
+
+- Author 1 - <[email protected]>
+- Author 2 - <[email protected]>
+- Author 3 - <[email protected]>
+
+## License
+
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
+
+[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

docs/code_of_conduct.md

@@ -0,0 +1,73 @@
+---
+title: Code of Conduct for Pumas-AI Workshop PLACEHOLDER
+description: Participants and Instructors must follow this at all times.
+---
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+At Pumas-AI we are committed to creating a friendly and respectful place for learning,
+teaching and contributing.
+All participants in our events and communications are expected to show respect and courtesy to others.
+To make clear what is expected,
+everyone participating in Pumas-AI activities is required to conform to the Code of Conduct.
+
+Pumas-AI is dedicated to providing a welcoming and supportive environment for all people,
+regardless of background or identity.
+As such, we do not tolerate behaviour that is disrespectful to our instructors or learners or that excludes,
+intimidates, or causes discomfort to others.
+We do not tolerate discrimination or harassment based on characteristics that include,
+but are not limited to, gender identity and expression, sexual orientation, disability,
+physical appearance, body size, citizenship, nationality, ethnic or social origin, pregnancy,
+familial status, veteran status, genetic information, religion or belief (or lack thereof),
+membership of a national minority, property, age, education, socio-economic status,
+technical choices, and experience level.
+
+## Expected Behaviour
+
+All participants in our events and communications are expected to show respect and courtesy to others.
+All interactions should be professional regardless of platform: either online or in-person.
+In order to foster a positive and professional learning environment we encourage the following kinds of behaviours
+in all Pumas-AI events and platforms:
+
+- Use welcoming and inclusive language
+- Be respectful of different viewpoints and experiences
+- Gracefully accept constructive criticism
+- Focus on what is best for the community
+- Show courtesy and respect towards other community members
+
+## Unacceptable Behaviour
+
+Examples of unacceptable behaviour by participants at any Pumas-AI event/platform include:
+
+- written or verbal comments which have the effect of excluding people on the basis of membership of any specific group
+- causing someone to fear for their safety, such as through stalking, following, or intimidation
+- violent threats or language directed against another person
+- the display of sexual or violent images
+- unwelcome sexual attention
+- nonconsensual or unwelcome physical contact
+- sustained disruption of talks, events or communications
+- insults or put downs
+- sexist, racist, homophobic, transphobic, ableist, or exclusionary jokes
+- excessive swearing
+- incitement to violence, suicide, or self-harm
+- continuing to initiate interaction (including photography or recording) with someone after being asked to stop
+- publication of private communication without consent
+
+## Consequences of Unacceptable Behaviour
+
+Participants who are asked to stop any inappropriate behaviour are expected to comply immediately.
+This applies to any Pumas-AI events and platforms, either online or in-person.
+If a participant engages in behaviour that violates this code of conduct,
+the organisers may warn the offender, ask them to leave the event or platform (without refund, if applicable),
+or engage with Pumas-AI representatives to investigate the Code of Conduct violation and impose appropriate sanctions.
+
+## Get in touch
+
+If you have any suggestions or want to get in touch with our education team,
+please send an email to <[email protected]>.
+
+## License
+
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 Internacional](http://creativecommons.org/licenses/by-sa/4.0/).
+
+[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

docs/contribute.md

@@ -0,0 +1,14 @@
+---
+title: How to Contribute 
+---
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+If you want to contribute to this workshop,
+please open a pull request at [`PumasAI-Labs/PLACEHOLDER`](https://github.com/PumasAI-Labs/PLACEHOLDER).
+
+By submitting a pull request,
+you are in accordance that your contribution will be licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
+
+Once your pull request is approved and merged,
+you'll be acknowledged as one of the authors in the workshop site and GitHub repository.

docs/index.md

@@ -0,0 +1,38 @@
+---
+title: Pumas-AI Workshop PLACEHOLDER
+description: CHANGE ME.
+---
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+Short summary about the workshop.
+
+!!! success "Prerequisites"
+
+    This workshop does PLACEHOLDER and PLACEHOLDER.
+    We recommend users being familiar with PLACEHOLDER, especially PLACEHOLDER.
+
+    The formal requirements are the PLACEHOLDER WORKSHOP WITH LINK.
+
+## Schedule
+
+| Time (HH:MM) | Activity | Description                              |
+| ------------ | -------- | ---------------------------------------- |
+| 00:00        | Setup    | Download files required for the workshop |
+
+## Get in touch
+
+If you have any suggestions or want to get in touch with our education team,
+please send an email to <[email protected]>.
+
+## Authors
+
+- Author 1 - <[email protected]>
+- Author 2 - <[email protected]>
+- Author 3 - <[email protected]>
+
+## License
+
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
+
+[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

docs/instructors.md

@@ -0,0 +1,18 @@
+---
+title: Instructor's Notes for Pumas-AI Workshop PLACEHOLDER
+---
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+PLACEHOLDER.
+
+## Get in touch
+
+If you have any suggestions or want to get in touch with our education team,
+please send an email to <[email protected]>.
+
+## License
+
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
+
+[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

docs/reference.md

@@ -0,0 +1,36 @@
+---
+title: Reference Sheets for Pumas-AI Workshop PLACEHOLDER
+---
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+## Key Points
+
+This can be either a markdown table or a list.
+
+## Summary of Basic Commands
+
+| Action      | Command       | Observations          |
+| ----------- | ------------- | --------------------- |
+| placeholder | `placeholder` | this is a placeholder |
+
+## Glossary
+
+`term1`
+
+: Definition of the term one above.
+
+`term2`
+
+: Definition of the term two above.
+
+## Get in touch
+
+If you have any suggestions or want to get in touch with our education team,
+please send an email to <[email protected]>.
+
+## License
+
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
+
+[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

docs/waiver.md

@@ -0,0 +1,35 @@
+---
+title: Waiver of Liability for Pumas-AI Workshop PLACEHOLDER
+---
+
+[![CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](http://creativecommons.org/licenses/by-sa/4.0/)
+
+By using the content provided by Pumas-AI, you agree to the following:
+
+1. You acknowledge that Pumas-AI has provided you with access to certain content (the "Content"),
+   including but not limited to software, documentation, images, videos, and other materials.
+1. You understand and agree that the Content is provided "as is," without warranty of any kind,
+   either express or implied, including but not limited to the implied warranties of merchantability
+   and fitness for a particular purpose.
+1. You acknowledge that Pumas-AI is not responsible for how you use the Content,
+   and that Pumas-AI shall not be liable for any damages arising from your use of the Content,
+   including but not limited to direct, indirect, incidental, special, consequential, or punitive damages,
+   whether in an action of contract, negligence, or other tortious action,
+   even if Pumas-AI has been advised of the possibility of such damages.
+1. You agree to indemnify, defend, and hold harmless Pumas-AI, its officers, directors, employees, agents,
+   and affiliates from and against any and all claims, damages, losses, liabilities,
+   and expenses (including reasonable attorneys' fees) arising from your use of the Content.
+1. You acknowledge that this Waiver of Liability is a legally binding agreement between you and Pumas-AI,
+   and that it governs your use of the Content.
+   If you do not agree to the terms of this Waiver of Liability, you must immediately cease using the Content.
+
+## Get in touch
+
+If you have any suggestions or want to get in touch with our education team,
+please send an email to <[email protected]>.
+
+## License
+
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
+
+[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

mkdocs.yml

@@ -0,0 +1,76 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+site_name: Pumas-AI Workshop PLACEHOLDER
+repo_name: PumasAI-Labs/Workshop-PLACEHOLDER
+repo_url: https://github.com/PumasAI-Labs/Workshop-PLACEHOLDER
+copyright: Copyright © 2023 Pumas-AI, Inc.
+plugins:
+  - search
+theme:
+  name: material
+  logo: assets/logo.png
+  icon:
+    repo: fontawesome/brands/github
+  favicon: assets/logo.png
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  font:
+    text: Roboto
+    code: Roboto Mono
+  highlightjs: true
+  hljs_languages:
+      - yaml
+      - julia
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.instant
+    - navigation.footer
+    - search.suggest
+    - search.highlight
+    - toc.follow
+    - toc.integrate
+extra:
+  homepage: https://pumas.ai
+  generator: false
+  social:
+    - icon: fontawesome/solid/globe
+      link: https://pumas.ai
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/pumas_ai
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/pumas-ai
+    - icon: fontawesome/solid/paper-plane
+      link: mailto:[email protected]
+markdown_extensions:
+  - tables
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - def_list
+nav:
+  - Home: index.md
+  - Reference Sheet: reference.md
+  - Instructor's Note: instructors.md
+  - Code of Conduct: code_of_conduct.md
+  - Waiver of Liability: waiver.md
+  - How to Contribute: contribute.md