Merge pull request #4 from lapix-ufsc/add-nbdev-setup

add nbdev setup

Author: johnnv1

.github/workflows/deploy.yaml

@@ -0,0 +1,9 @@
+name: Deploy to GitHub Pages
+on:
+  push:
+    branches: [ "main", "master" ]
+  workflow_dispatch:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps: [uses: fastai/workflows/quarto-ghp@master]

MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

dl-tutorials/.gitignore

@@ -0,0 +1,2 @@
+/.quarto/
+_docs/

dl-tutorials/_quarto.yml

@@ -0,0 +1,39 @@
+ipynb-filters: [nbdev_filter]
+
+project:
+  type: website
+  output-dir: _docs
+  preview:
+    port: 3000
+    browser: false
+
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+    toc-depth: 4
+
+website:
+  title: "Lapix - Deep learning tutorials"
+  description: "This repository contains demonstrations done with deep learning computer vision models."
+  execute: 
+    enabled: false
+  twitter-card: true
+  open-graph: true
+  reader-mode: true
+  repo-branch: main
+  repo-url: https://github.com/lapix-ufsc/dl-tutorials/
+  repo-actions: [issue]
+  navbar:
+    background: primary
+    search: true
+    right:
+      - icon: github
+        href: https://github.com/lapix-ufsc/dl-tutorials/
+  sidebar:
+    style: "floating"
+
+metadata-files: 
+  - sidebar.yml
+  - custom.yml

dl-tutorials/index.ipynb

@@ -0,0 +1,92 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Deep Learning tutorials\n",
+    "\n",
+    "> This repository contains demonstrations done with deep learning models for computer vision."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Content"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This package/repository is not a library, but a set of tutorials using several libraries with models and utilities for computer vision using deep learning. \n",
+    "\n",
+    "These tutorials were built in a way that their contents are self-contained, and that they can be used as a basis for other experiments.\n",
+    "\n",
+    "The tutorials will cover models and tools for semantic segmentation, object detection, image classification, tracking, augmentation, model evaluation, among other topics."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Datasets"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "These tutorials are the fruit of different Lapix researchers, who throughout their masters or doctoral degrees developed several computer vision datasets.\n",
+    "\n",
+    "Therefore, these tutorials were created from experiments using the following datasets:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "1. [CCAgT: Images of Cervical Cells with AgNOR Stain Technique](https://doi.org/10.17632/wg4bpm33hj.2) \n",
+    "1. [Clouds-1000](https://doi.org/10.17632/4pw8vfsnpx.2)\n",
+    "1. [UFSC OCPap: Papanicolaou Stained Oral Cytology Dataset (v4)](https://doi.org/10.17632/dr7ydy9xbk.1)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Authors"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "|             Name             | GitHub                                   | Orcid                                                        |\n",
+    "| :--------------------------: | ---------------------------------------- | ------------------------------------------------------------ |\n",
+    "|     Aldo von Wangenheim      | [@awangenh](https://github.com/awangenh) | [0000-0003-4532-1417](https://orcid.org/0000-0003-4532-1417) |\n",
+    "| João Gustavo Atkinson Amorim | [@johnnv1](http://github.com/johnnv1)    | [0000-0003-3361-6891](https://orcid.org/0000-0003-3361-6891) |\n",
+    "|                              |                                          |                                                              |\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.8.10 ('venv': venv)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.8.10"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "14fc90b036d17ab8931f0afc7b06851673501038f7e6077c614cdf5f462d6df3"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

dl-tutorials/sidebar.yml

@@ -0,0 +1,4 @@
+website:
+  sidebar:
+    contents:
+      - index.ipynb

dl-tutorials/styles.css

@@ -0,0 +1,18 @@
+.cell-output pre {
+    margin-left: 0.8rem;
+    margin-top: 0;
+    background: none;
+    border-left: 2px solid lightsalmon;
+    border-top-left-radius: 0;
+    border-top-right-radius: 0;
+  }
+  
+  .cell-output .sourceCode {
+    background: none;
+    margin-top: 0;
+  }
+  
+  .cell > .sourceCode {
+    margin-bottom: 0;
+  }
+  

settings.ini

@@ -0,0 +1,38 @@
+[DEFAULT]
+host = github
+lib_name = Lapix - Deep learning tutorials
+description = This repository contains demonstrations done with deep learning computer vision models.
+# copyright = Put your copyright info here
+keywords = "computer vision" "deep learning" "tutorials" "computer vision tutorial" "deep learning tutorials"
+user = lapix-ufsc
+author = lapix
+repo = dl-tutorials
+branch = main
+version = 0.0.1-alpha
+min_python = 3.7
+audience = Developers
+language = English
+custom_sidebar = False
+license = mit
+status = 2
+nbs_path = ./dl-tutorials/
+doc_path = _docs
+recursive = False
+tst_flags = notest
+
+### Inferred From Other Values ###
+doc_host =  https://%(user)s.github.io
+doc_baseurl = /%(lib_name)s/
+git_url = https://github.com/%(user)s/%(repo)s/
+lib_path = %(lib_name)s
+title = %(lib_name)s
+
+### OPTIONAL ### see https://github.com/fastai/nbdev/blob/master/settings.ini for examples
+
+# requirements = 
+# dev_requirements = 
+# console_scripts =
+
+
+
+