readme additions initial commit

docs/docker-setup.md

@@ -0,0 +1,39 @@
+# DockerSetup
+
+This is a short version of howto install Docker on Ubuntu 20.04. It is basically a summary of the following source:\
+* https://docs.docker.com/install/linux/docker-ce/ubuntu/#os-requirements
+
+## Install Docker
+```bash
+sudo apt update
+sudo apt-get install \
+    apt-transport-https \
+    ca-certificates \
+    curl \
+    gnupg \
+    lsb-release
+
+curl -fsSL https://download.docker.com/linux/ubuntu/gpg |\
+    sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+echo \
+    "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] \
+    https://download.docker.com/linux/ubuntu \
+    $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+sudo apt update
+sudo apt install docker-ce
+```
+
+## Add user to "docker" group & re-login
+Add yourself to the docker group (to get access to the docker deamon socket)\
+note: beeing member of docker gives you root access via the docker deamon
+```bash 
+sudo usermod -a -G docker `whoami`
+```
+Logout / Login to load the new group rights\
+Using Ubuntu Gnome it may be required to restart
+
+## Install Docker-Compose
+```bash
+sudo apt install python3-pip
+sudo pip3 install docker-compose
+```

docs/huggingface-spaces.md

@@ -0,0 +1,58 @@
+Hugging Face Spaces and GitHub repositories serve different but complementary purposes. Here’s a comparison and how they can be used together:
+
+### Comparison with GitHub Repositories
+
+- **GitHub Repository**:
+  - **Purpose**: Primarily used for version control, collaboration, and sharing of code and projects.
+  - **Capabilities**: Stores code, tracks changes, manages issues, and supports CI/CD pipelines.
+  - **Usage**: Developers collaborate on software development projects, manage codebases, and deploy applications.
+
+- **Hugging Face Spaces**:
+  - **Purpose**: Designed specifically for deploying interactive machine learning applications and demos.
+  - **Capabilities**: Hosts and deploys machine learning models and applications using frameworks like Streamlit, Gradio, or custom HTML/CSS/JS.
+  - **Usage**: Users create and share interactive demos and applications, especially in the field of machine learning.
+
+### Integration with GitHub
+
+You can import a GitHub repository into Hugging Face Spaces to deploy an application hosted on GitHub. Here’s how to do it:
+
+1. **Create a Space on Hugging Face**:
+   - Go to the Hugging Face Spaces website and create a new Space.
+
+2. **Link to GitHub Repository**:
+   - During the setup of the new Space, you can link it to a GitHub repository. This allows Hugging Face Spaces to pull the code from your GitHub repo.
+
+3. **Configure Your Space**:
+   - Ensure your repository contains the necessary files for the framework you are using (Streamlit, Gradio, or HTML/CSS/JS).
+   - For example, if you are using Streamlit, ensure you have a `requirements.txt` file for dependencies and a main Python script that runs the Streamlit app.
+
+4. **Deploy the Application**:
+   - Once linked, Hugging Face Spaces will automatically deploy the application from the GitHub repository.
+   - Any updates pushed to the GitHub repository can automatically trigger redeployment of the application on Hugging Face Spaces.
+
+### Example Steps to Import a GitHub Repo into Hugging Face Spaces
+
+1. **Create a New Space**:
+   - Navigate to Hugging Face Spaces and click on “New Space”.
+   
+2. **Set Up Space**:
+   - Choose a name for your Space, select the appropriate SDK (e.g., Streamlit, Gradio, or HTML), and choose the visibility (public or private).
+
+3. **Connect GitHub Repository**:
+   - In the Space settings, you will find an option to link a GitHub repository. Provide the URL of your GitHub repository.
+   - Hugging Face Spaces will clone your GitHub repository to use it as the source code for your Space.
+
+4. **Configure and Deploy**:
+   - Make sure your GitHub repository is set up correctly for the chosen framework. For example, a Streamlit app should have a `requirements.txt` and an entry-point script like `app.py`.
+   - Once everything is set up, your Space will be deployed and can be accessed via a URL provided by Hugging Face.
+
+5. **Update and Maintain**:
+   - Any changes you push to the linked GitHub repository will be reflected in the deployed application after the repository is synced with Hugging Face Spaces.
+
+### Benefits
+
+- **Version Control**: Leveraging GitHub’s version control capabilities ensures that your code is managed effectively.
+- **Collaboration**: Teams can collaborate on the development of the application using GitHub’s collaborative tools.
+- **Easy Deployment**: Hugging Face Spaces simplifies the deployment of interactive machine learning applications without the need for complex infrastructure management.
+
+By combining the strengths of GitHub and Hugging Face Spaces, you can efficiently develop, manage, and deploy machine learning applications.