Merge pull request #1 from fdabek1/develop

v0.1.0 release
fdabek1 · Jun 30, 2020 · e0b8c6c · e0b8c6c
2 parents eed9872 + ec43512
commit e0b8c6c
Show file tree

Hide file tree

Showing 19 changed files with 11,354 additions and 24 deletions.
diff --git a/.gitignore b/.gitignore
@@ -138,10 +138,8 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-# static files generated from Django application using `collectstatic`
-media
-static
-
-# editors
+# IntelliJ IDE
 .idea
-.vscode
+
+# NPM modules
+node_modules
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2020-XX-XX
+### Added
+- Initial release.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Filip Dabek
+
+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.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Filip Dabek
+
+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.
diff --git a/deploy_docs.sh b/deploy_docs.sh
@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+# abort on errors
+set -e
+
+# build
+npm run docs:build
+
+# navigate into the build output directory
+cd docs/.vuepress/dist
+
+# if you are deploying to a custom domain
+# echo 'www.example.com' > CNAME
+
+git init
+git add -A
+git commit -m 'deploy'
+
+# if you are deploying to https://<USERNAME>.github.io
+# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master
+
+# if you are deploying to https://<USERNAME>.github.io/<REPO>
+git push -f git@github.com:fdabek1/rura.git master:gh-pages
+
+cd -
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,62 @@
+module.exports = {
+  base: '/rura/',
+  title: 'Rura',
+  description: 'Documentation of the Rura library',
+  head: [
+    ['link', {rel: 'icon', href: '/favicon.ico'}] // TODO - This doesnt work
+  ],
+  themeConfig: {
+    docsDir: 'docs',
+    nav: [
+      {text: 'Home', link: '/'},
+      {text: 'Usage', link: '/usage/'},
+      {text: 'Components', link: '/components/'},
+      {text: 'Models', link: '/models/'},
+    ],
+    displayAllHeaders: true,
+    sidebar: {
+      '/usage/': [
+        'codes',
+      ],
+      '/components/':
+        [
+          {
+            title: 'Data',
+            collapsable: false,
+            children: [
+              'data/',
+              'data/external',
+            ]
+          },
+          {
+            title: 'Transform',
+            collapsable: false,
+            children: [
+              'transform/',
+            ]
+          },
+          {
+            title: 'Model',
+            collapsable: false,
+            children: [
+              'model/',
+            ]
+          },
+          {
+            title: 'Process',
+            collapsable: false,
+            children: [
+              'process/',
+            ]
+          },
+          {
+            title: 'Metric',
+            collapsable: false,
+            children: [
+              'metric/',
+            ]
+          },
+        ],
+    }
+  }
+};
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,19 @@
+---
+home: true
+heroImage: /hero.png
+actionText: Get Started →
+actionLink: /usage/
+footer: 
+---
+
+## Rura
+
+> Pipelines for machine learning.
+
+## About
+
+
+
+::: warning
+The documentation is still being written out so a lot of sections are left blank.
+:::
diff --git a/docs/components/README.md b/docs/components/README.md
@@ -0,0 +1 @@
+# Components
diff --git a/docs/components/data/README.md b/docs/components/data/README.md
@@ -0,0 +1 @@
+# Data
diff --git a/docs/components/data/external.md b/docs/components/data/external.md
@@ -0,0 +1 @@
+# External Data
diff --git a/docs/components/metric/README.md b/docs/components/metric/README.md
@@ -0,0 +1 @@
+# Structure
diff --git a/docs/components/model/README.md b/docs/components/model/README.md
@@ -0,0 +1,26 @@
+# Structure
+
+Models
+
+## Methods
+a
+
+## set_parameters_data
+
+### build
+a
+
+### log_parameters
+a
+
+### fit
+a
+
+### predict
+a
+
+### load
+a
+
+## log_model
+a
diff --git a/docs/components/process/README.md b/docs/components/process/README.md
@@ -0,0 +1 @@
+# Structure
diff --git a/docs/components/transform/README.md b/docs/components/transform/README.md
@@ -0,0 +1,10 @@
+# Transform
+
+## Parameters
+
+### has_y
+
+### files
+
+## transform
+
diff --git a/environment.yml b/environment.yml