setup github actions

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+      - simple_dataloaders
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: pip install mkdocs-material-extensions
+      - run: pip install mkdocs-jupyter
+      - run: pip install mkdocs-redirects
+      - run: pip install mkdocs-autorefs
+      - run: pip install mkdocs-awesome-pages-plugin
+      - run: pip install mkdocstrings
+      - run: pip install mkdocstrings-python
+      - run: pip install mknotebooks
+      - run: mkdocs gh-deploy --force

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

docs/Docker reference/index.md

@@ -0,0 +1,31 @@
+# OpenML-Tensorflow container
+
+The docker container has the latest version of OpenML-Tensorflow downloaded and pre-installed. It can be used to run TensorFlow Deep Learning analysis on OpenML datasets. 
+This document contains information about:
+
+[Usage](#usage): how to use the image 
+
+## Usage
+
+These are the steps to use the image:
+
+1. Pull the docker image 
+```
+docker pull taniyadas/openml-tensorflow:latest
+```
+2. If you want to run a local script, it needs to be mounted first. Mount it into the 'app' folder:
+```text
+docker run -it -v PATH/TO/CODE_FOLDER:/app taniyadas/openml-tensorflow /bin/bash
+```
+You can also mount multiple directories into the container (such as your code file directory and dataset directory ) using:
+```text
+docker run -t -i -v PATH/TO/CODE_FOLDER:/app -v PATH/TO/DATASET_FOLDER:/app/dataset taniyadas/openml-tensorflow /bin/bash
+```
+3. Please make sure to give the correct path to the dataset. For example, 
+```text
+openml_tensorflow.config.dir = 'dataset/Images'
+```
+4. Run your code scripts using:
+```text
+ python my_code.py
+```

mkdocs.yml

@@ -53,6 +53,7 @@ plugins:
 nav:
   - Home: "index.md"
   - API Reference:
+  - Docker Reference:
   - Examples:
   - "Limitations of the API":  "Limitations of the API.md"