Skip to content

Commit

Permalink
Start book framework
Browse files Browse the repository at this point in the history
  • Loading branch information
bnorthan committed Oct 7, 2023
0 parents commit d6991b9
Show file tree
Hide file tree
Showing 17 changed files with 164 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: deploy-book

# Only run this when the master branch changes
on:
push:
branches:
- master
- main

# This job installs dependencies, build the book, and pushes it to `gh-pages`
jobs:
deploy-book:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

# Install dependencies
- name: Set up Python 3.7
uses: actions/setup-python@v1
with:
python-version: 3.7

- name: Install dependencies
run: |
pip install -r requirements.txt
# Build the book
- name: Build the book
run: |
jupyter-book build docs/
# Push the book's HTML to github-pages
- name: GitHub Pages action
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/_build
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 True-North-Intelligent-Algorithms

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# intro-to-data-analysis
An introduction to Python and the Python data analysis ecosystem
4 changes: 4 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
jupyter-book build docs/

open docs/_build/html/index.html

1 change: 1 addition & 0 deletions clean.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
rm -rf build docs/_build
5 changes: 5 additions & 0 deletions docs/10_intro/10_Module1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Module 1 Introduction to Deconvolution

## Todo:

Start the slides...
3 changes: 3 additions & 0 deletions docs/10_intro/20_Libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Libraries

Test to see if the libraries are installed correctly
22 changes: 22 additions & 0 deletions docs/20_deep_learning/10_Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Introduction to Data Wrangling

## What is data Wrangling??
[From Wikipedia](https://en.wikipedia.org/wiki/Data_wrangling)

Data wrangling, sometimes referred to as data munging, is the process of transforming and mapping data from one "raw" data form into another format with the intent of making it more appropriate and valuable for a variety of downstream purposes such as analytics. A data wrangler is a person who performs these transformation operations.

In this class we will use Pandas for "Data Wrangling"

## Why Pandas??

Pandas is a python library. It allows us to manipulate data programatically. Then we can apply other tool sets (like the plotting library matplotlib or the machine learning libary scikitlearn) downstream.

## Data Wrangling operations we will learn

* Read .csv, text and excel files
* Use Groupby to summarize data
* Sort data
* Clean data
* Eliminate un-needed or redundant data
* Join, Merge and Concatenate data

3 changes: 3 additions & 0 deletions docs/20_deep_learning/20_Care.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CARE

Explain CARE Network
3 changes: 3 additions & 0 deletions docs/90_notes/10_notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Notes

Todo: Notes
3 changes: 3 additions & 0 deletions docs/90_notes/20_notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Second set of notes

More notes...
26 changes: 26 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# In _config.yml
logo: logo.jpeg
execute:
execute_notebooks: off

# Add a bibtex file so that we can create citations
#bibtex_bibfiles:
# - references.bib

# Information about where the book exists on the web
repository:
url: https://github.com/True-North-Intelligent-Algorithms/deconvolution-gpu-dl-course # Online location of your book
branch: main # Which branch of the repository should be used when creating links (optional)

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
use_issues_button: true
use_repository_button: true
extra_footer: |
<p>
Copyright: This work can be reused under the terms of the <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">CC-BY 4.0</a> license unless mentioned otherwise.
</p>
sphinx:
config:
html_show_copyright: false
22 changes: 22 additions & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html

format: jb-book
root: intro

options: # The options key will be applied to all chapters, but not sub-sections
numbered: False

parts:
- caption: Exploring the Intersection of Deconvolution, GPU Computing, and Deep Learning
chapters:
- file: 10_intro/10_Module1
sections:
- file: 10_intro/20_Libraries
- file: 20_deep_learning/10_Introduction
sections:
- file: 20_deep_learning/20_Care
- file: 90_notes/10_notes
sections:
- file: 90_notes/20_notes

7 changes: 7 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Intro to Exploring the Intersection of Deconvolution, GPU Computing, and Deep Learning

Learn

* the basics of deconvoluton
* how to use GPUs for deconvolution
* how to train deep neural networks for image restoration
Binary file added docs/logo.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
jupyter-book
matplotlib
numpy

0 comments on commit d6991b9

Please sign in to comment.