From 38c201a13f14c317b3fa561c40b6df55690c5b96 Mon Sep 17 00:00:00 2001 From: <> Date: Sat, 9 Jul 2022 21:12:02 +0000 Subject: [PATCH] Deployed 63a4598 with MkDocs version: 1.3.0 --- 404.html | 180 +- example_secrets.ini | 5 - explanation/explanation.md | 7 + explanation/index.html | 214 +- great_ai_example-main/Dockerfile | 11 - great_ai_example-main/README.md | 23 - great_ai_example-main/format.sh | 31 - great_ai_example-main/index.html | 471 ---- great_ai_example-main/requirements.txt | 4 - great_ai_example-main/src/mongo.ini | 2 - hello_world/hello_world.ipynb | 87 - hello_world/hello_world.py | 8 - how-to-guides/index.html | 224 +- how-to-guides/{how-to-guides.md => index.md} | 0 .../scraping}/index.html | 298 ++- how-to-guides/scraping/scraping.ipynb | 29 + ideas.drawio | 230 -- index.html | 246 +- index.md | 45 +- media/favicon.ico | Bin 0 -> 15086 bytes media/logo.png | Bin 0 -> 86546 bytes .../scope-data.drawio.svg | 40 +- .../diagrams => media}/scope-data.svg | 0 .../diagrams => media}/scope-deploy.svg | 0 .../scope-simple.drawio.svg | 0 .../diagrams => media}/scope-train.svg | 0 .../diagrams => media}/scope.svg | 0 media/scoutinscience-white.svg | 122 + media/scoutinscience.svg | 121 + open_s3/index.html | 182 +- reference/index.html | 184 +- search/search_index.json | 2 +- simple-mag/train/index.html | 211 +- .../src => simple}/data/data.ipynb | 0 .../src => simple}/data/index.html | 347 ++- .../src => simple}/deploy/deploy.ipynb | 5 +- .../src => simple}/deploy/index.html | 323 ++- .../src => simple}/train/index.html | 340 ++- .../src => simple}/train/train.ipynb | 0 sitemap.xml | 26 +- sitemap.xml.gz | Bin 205 -> 205 bytes {simple-mag/mag => tutorial/data}/dev.txt | 0 {simple-mag/mag => tutorial/data}/test.txt | 0 {simple-mag/mag => tutorial/data}/train.txt | 0 tutorial/deploy/deploy.ipynb | 214 ++ tutorial/deploy/index.html | 2023 +++++++++++++++ {tutorials => tutorial}/index.html | 374 ++- tutorial/index.md | 70 + tutorial/train/index.html | 2306 +++++++++++++++++ tutorial/train/train.ipynb | 318 +++ tutorials/tutorials.md | 0 51 files changed, 7876 insertions(+), 1447 deletions(-) delete mode 100644 example_secrets.ini delete mode 100644 great_ai_example-main/Dockerfile delete mode 100644 great_ai_example-main/README.md delete mode 100644 great_ai_example-main/format.sh delete mode 100644 great_ai_example-main/index.html delete mode 100644 great_ai_example-main/requirements.txt delete mode 100644 great_ai_example-main/src/mongo.ini delete mode 100644 hello_world/hello_world.ipynb delete mode 100644 hello_world/hello_world.py rename how-to-guides/{how-to-guides.md => index.md} (100%) rename {hello_world => how-to-guides/scraping}/index.html (98%) create mode 100644 how-to-guides/scraping/scraping.ipynb delete mode 100644 ideas.drawio create mode 100644 media/favicon.ico create mode 100644 media/logo.png rename scope-data.drawio.svg => media/scope-data.drawio.svg (83%) rename {great_ai_example-main/diagrams => media}/scope-data.svg (100%) rename {great_ai_example-main/diagrams => media}/scope-deploy.svg (100%) rename scope-simple.drawio.svg => media/scope-simple.drawio.svg (100%) rename {great_ai_example-main/diagrams => media}/scope-train.svg (100%) rename {great_ai_example-main/diagrams => media}/scope.svg (100%) create mode 100644 media/scoutinscience-white.svg create mode 100644 media/scoutinscience.svg rename {great_ai_example-main/src => simple}/data/data.ipynb (100%) rename {great_ai_example-main/src => simple}/data/index.html (98%) rename {great_ai_example-main/src => simple}/deploy/deploy.ipynb (99%) rename {great_ai_example-main/src => simple}/deploy/index.html (98%) rename {great_ai_example-main/src => simple}/train/index.html (98%) rename {great_ai_example-main/src => simple}/train/train.ipynb (100%) rename {simple-mag/mag => tutorial/data}/dev.txt (100%) rename {simple-mag/mag => tutorial/data}/test.txt (100%) rename {simple-mag/mag => tutorial/data}/train.txt (100%) create mode 100644 tutorial/deploy/deploy.ipynb create mode 100644 tutorial/deploy/index.html rename {tutorials => tutorial}/index.html (50%) create mode 100644 tutorial/index.md create mode 100644 tutorial/train/index.html create mode 100644 tutorial/train/train.ipynb delete mode 100644 tutorials/tutorials.md diff --git a/404.html b/404.html index dd6a69b..cb5fc32 100644 --- a/404.html +++ b/404.html @@ -12,7 +12,7 @@ - + @@ -244,13 +244,74 @@ + +
  • + + + + + + + + + + +
    • + + @@ -259,13 +320,107 @@ + +
  • + + + + + + + + + + +
    • + + @@ -297,21 +452,6 @@ - - - - - - - -
  • - - Train a field of study (domain) classification of sentences on the MAG dataset - -
    • - - - diff --git a/example_secrets.ini b/example_secrets.ini deleted file mode 100644 index 9d8f335..0000000 --- a/example_secrets.ini +++ /dev/null @@ -1,5 +0,0 @@ -aws_region_name = your_region_like_eu-west-2 -aws_access_key_id = YOUR_ACCESS_KEY_ID -aws_secret_access_key = YOUR_VERY_SECRET_ACCESS_KEY -large_files_bucket_name = create_a_bucket_and_put_its_name_here -aws_endpoint_url = this is optional, for backblaze, use this: https://s3.us-west-002.backblazeb2.com diff --git a/explanation/explanation.md b/explanation/explanation.md index e69de29..5f30f0a 100644 --- a/explanation/explanation.md +++ b/explanation/explanation.md @@ -0,0 +1,7 @@ +# Explanation + +A lot more details and discussion about the problem context and approaches of GreatAI can be found in my thesis. + +
    +[::fontawesome-solid-graduation-cap: Download](thesis/main.py){ .md-button .md-button--primary } +
    diff --git a/explanation/index.html b/explanation/index.html index 064f1dd..3c460af 100644 --- a/explanation/index.html +++ b/explanation/index.html @@ -12,7 +12,7 @@ - + @@ -69,6 +69,11 @@
    + + + Skip to content + +
    @@ -244,13 +249,74 @@ + +
  • + + + + + + + + + + +
    • + + @@ -259,13 +325,107 @@ + +
  • + + + + + + + + + + +
    • + + @@ -296,6 +456,8 @@ + + Explanation @@ -305,21 +467,6 @@ - - - - - - - -
  • - - Train a field of study (domain) classification of sentences on the MAG dataset - -
    • - - -
    @@ -337,6 +484,8 @@ + + @@ -357,16 +506,18 @@ -

    Explanation

    - - +

    Explanation#

    +

    A lot more details and discussion about the problem context and approaches of GreatAI can be found in my thesis.

    +
    +

    : Download

    +
    Last update: - July 8, 2022 + July 9, 2022 @@ -402,21 +553,6 @@ - - -
    diff --git a/great_ai_example-main/Dockerfile b/great_ai_example-main/Dockerfile deleted file mode 100644 index bd5c6cc..0000000 --- a/great_ai_example-main/Dockerfile +++ /dev/null @@ -1,11 +0,0 @@ -FROM test - -COPY requirements.txt . -RUN pip install --no-cache-dir ./great_ai - -COPY mongo.ini . -COPY deploy.ipynb . - -# RUN python3 -m large_file --backend s3 -secrets ~/.aws/credentials --cache my_first_file.json:3 my_second_file my_folder:0 - -CMD ["deploy.ipynb"] diff --git a/great_ai_example-main/README.md b/great_ai_example-main/README.md deleted file mode 100644 index d52e649..0000000 --- a/great_ai_example-main/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# Train a domain classifier on the [semantic scholar dataset](https://api.semanticscholar.org/corpus) - -![steps](diagrams/scope.svg) - -## Install - -### System dependencies - -Make sure you have `python3`, `pip`, and `venv` installed. -> On Ubuntu, execute: `sudo apt install -y python3 python3-pip python3-venv` - -### Install dependencies -```sh -python3 -m venv --copies .env -source .env/bin/activate - -pip install -r requirements.txt -``` -## Execute - -- [Part 1](src/data.ipynb) -- [Part 2](src/train.ipynb) -- [Part 3](src/deploy.ipynb) diff --git a/great_ai_example-main/format.sh b/great_ai_example-main/format.sh deleted file mode 100644 index 737a2b9..0000000 --- a/great_ai_example-main/format.sh +++ /dev/null @@ -1,31 +0,0 @@ -#!/bin/sh - -set -e - -echo "Installing dependencies if necessary" -python3 -m pip install --upgrade autoflake isort black[jupyter] mypy flake8 - -echo "Formatting and checking $1" - -cd $1 - -echo Running autoflake -python3 -m autoflake --expand-star-imports --remove-all-unused-imports --ignore-init-module-imports --remove-unused-variables --in-place -r . - -echo Running isort -python3 -m isort --profile black --skip .env . - -echo Running black -python3 -m black . --exclude .env - -if ls *.py 1> /dev/null 2>&1; then - echo Running mypy - python3 -m mypy --namespace-packages --ignore-missing-imports --install-types --non-interactive --disallow-untyped-defs --disallow-incomplete-defs --pretty --follow-imports=silent --exclude=external/ --exclude=/build/ . -fi - -echo Running Flake8 -python3 -m flake8 . --count --show-source --statistics --exclude=__init__.py,.env,external --ignore=E501,E722,E402,W503,E203 - -cd - - -echo "Finished formatting" diff --git a/great_ai_example-main/index.html b/great_ai_example-main/index.html deleted file mode 100644 index 30d929f..0000000 --- a/great_ai_example-main/index.html +++ /dev/null @@ -1,471 +0,0 @@ - - - - - - - - - - - - - - - - - - - - Train a domain classifier on the [semantic scholar dataset](https://api.semanticscholar.org/corpus) - GreatAI documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - - - - -
    - - -
    - -
    - - - - - - -
    -
    - - - -
    -
    -
    - - - - -
    -
    -
    - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    - - - - - - - - - - - -

    Train a domain classifier on the semantic scholar dataset#

    -

    steps

    -

    Install#

    -

    System dependencies#

    -

    Make sure you have python3, pip, and venv installed.

    -
    -

    On Ubuntu, execute: sudo apt install -y python3 python3-pip python3-venv

    -
    -

    Install dependencies#

    -
    python3 -m venv --copies .env 
-source .env/bin/activate
-
-pip install -r requirements.txt
-
    -

    Execute#

    - - -
    -
    - - - Last update: - July 8, 2022 - - - -
    - - - -
    - -
    -
    - -
    - - - -
    -
    -
    -
    - - - - - - - - \ No newline at end of file diff --git a/great_ai_example-main/requirements.txt b/great_ai_example-main/requirements.txt deleted file mode 100644 index dfcc2e6..0000000 --- a/great_ai_example-main/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -great_ai -notebook -nbformat -nbconvert \ No newline at end of file diff --git a/great_ai_example-main/src/mongo.ini b/great_ai_example-main/src/mongo.ini deleted file mode 100644 index 8d22e1c..0000000 --- a/great_ai_example-main/src/mongo.ini +++ /dev/null @@ -1,2 +0,0 @@ -mongo_connection_string=mongodb://localhost:27017/ # change this -mongo_database=great_ai_example # this will be automatically created diff --git a/hello_world/hello_world.ipynb b/hello_world/hello_world.ipynb deleted file mode 100644 index d3fe2c0..0000000 --- a/hello_world/hello_world.ipynb +++ /dev/null @@ -1,87 +0,0 @@ -{ - "cells": [ - { - "cell_type": "code", - "execution_count": 1, - "metadata": {}, - "outputs": [ - { - "name": "stderr", - "output_type": "stream", - "text": [ - "\u001b[38;5;226m2022-07-08 10:26:12,806 | WARNING | Environment variable ENVIRONMENT is not set, defaulting to development mode ‼️\u001b[0m\n", - "\u001b[38;5;226m2022-07-08 10:26:12,807 | WARNING | Cannot find credentials files, defaulting to using ParallelTinyDbDriver\u001b[0m\n", - "\u001b[38;5;226m2022-07-08 10:26:12,807 | WARNING | The selected tracing database (ParallelTinyDbDriver) is not recommended for production\u001b[0m\n", - "\u001b[38;5;226m2022-07-08 10:26:12,808 | WARNING | Cannot find credentials files, defaulting to using LargeFileLocal\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,808 | INFO | Settings: configured ✅\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,809 | INFO | 🔩 tracing_database: ParallelTinyDbDriver\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,809 | INFO | 🔩 large_file_implementation: LargeFileLocal\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,811 | INFO | 🔩 is_production: False\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,811 | INFO | 🔩 should_log_exception_stack: True\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,812 | INFO | 🔩 prediction_cache_size: 512\u001b[0m\n", - "\u001b[38;5;39m2022-07-08 10:26:12,813 | INFO | 🔩 dashboard_table_size: 20\u001b[0m\n", - "\u001b[38;5;226m2022-07-08 10:26:12,813 | WARNING | You still need to check whether you follow all best practices before trusting your deployment.\u001b[0m\n", - "\u001b[38;5;226m2022-07-08 10:26:12,814 | WARNING | > Find out more at https://se-ml.github.io/practices/\u001b[0m\n" - ] - } - ], - "source": [ - "from great_ai import GreatAI\n", - "from asyncio import sleep\n", - "\n", - "\n", - "@GreatAI.create\n", - "async def hello_world(name: str) -> str:\n", - " await sleep(1)\n", - " return f\"Hello {name}!\"" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "Trace(trace_id='27c5e581-ad6e-4d50-bb77-862dfb7963fb', created='2022-07-08T08:26:12.911975', original_execution_time_ms=1.933, logged_values={'arg:name:value': 'hi', 'arg:name:length': 2}, models=[], exception=None, output='Hello hi!', feedback=None, tags=['hello_world', 'online', 'development'])" - ] - }, - "execution_count": 2, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "await hello_world('hi')" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3.10.4 ('.env': venv)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.10.4" - }, - "orig_nbformat": 4, - "vscode": { - "interpreter": { - "hash": "02dd6d3afbfa9fbbe1037d64ad9014965528a1ccad21929d6e72f466389a68ad" - } - } - }, - "nbformat": 4, - "nbformat_minor": 2 -} diff --git a/hello_world/hello_world.py b/hello_world/hello_world.py deleted file mode 100644 index e9b9960..0000000 --- a/hello_world/hello_world.py +++ /dev/null @@ -1,8 +0,0 @@ -from great_ai import GreatAI - - -@GreatAI.create -def hello_world(name: str) -> str: - """Learn more about GreatAI at https://github.com/schmelczer/great-ai""" - - return f"Hello {name}!" diff --git a/how-to-guides/index.html b/how-to-guides/index.html index da0e8e6..0ffa5c0 100644 --- a/how-to-guides/index.html +++ b/how-to-guides/index.html @@ -12,12 +12,12 @@ - + - How-To Guides - GreatAI documentation + Index - GreatAI documentation @@ -98,7 +98,7 @@
    - How-To Guides + Index
    @@ -244,13 +244,74 @@ + +
  • + + + + + + + + + + +
    • + + @@ -258,19 +319,105 @@ + +
  • + + + + + + + + + +
    • @@ -305,21 +452,6 @@ - - - - - - - -
  • - - Train a field of study (domain) classification of sentences on the MAG dataset - -
    • - - -
    @@ -351,13 +483,13 @@ - + -

    How-To Guides

    +

    Index

    @@ -366,7 +498,7 @@ Last update: - July 8, 2022 + July 9, 2022 @@ -383,42 +515,6 @@
    @@ -2430,27 +2560,6 @@ class="