solved merge

.gitignore

@@ -189,4 +189,5 @@ cython_debug/
 data/images/
 tmp/
 figures/
-archive/
+archive/
+segment-anything/

DisentanglementBase.py

@@ -181,12 +181,20 @@ class DisentanglementBase:
             bins = [(x-1) * 360 / (len(self.colors_list) - 1)  if x != 1 
                     else 1 for x in range(len(self.colors_list) + 1)]
             bins[0] = 0
+            
             y_cat = pd.cut(y, 
                             bins=bins,
                             labels=self.colors_list,
                             include_lowest=True
                             )
             print(y_cat.value_counts())
+            
+            y_h_cat[y_s == 0] = 'Gray'
+            y_h_cat[y_s == 100] = 'Gray'
+            y_h_cat[y_v == 0] = 'Gray'
+            y_h_cat[y_v == 100] = 'Gray'
+            
+            print(y_cat.value_counts())
             x_train, x_val, y_train, y_val = train_test_split(X, y_cat, test_size=0.2)
         else:
             if extremes:
@@ -567,11 +575,14 @@ def main():
     with dnnlib.util.open_url(model_file) as f:
         model = legacy.load_network_pkl(f)['G_ema'] # type: ignore
 
-    colors_list = ['Red', 'Orange', 'Yellow', 'Yellow Green', 'Chartreuse Green',
-                   'Kelly Green', 'Green Blue Seafoam', 'Cyan Blue',
-                   'Warm Blue', 'Indigo', 'Purple Magenta', 'Magenta Pink']
-    colors_list = ['Gray', 'Red Orange', 'Yellow', 'Green', 'Light Blue',
-                   'Blue', 'Violet', 'Pink']
+
+    # colors_list = ['Red', 'Orange', 'Yellow', 'Yellow Green', 'Chartreuse Green',
+    #                'Kelly Green', 'Green Blue Seafoam', 'Cyan Blue',
+    #                'Warm Blue', 'Indigo', 'Purple Magenta', 'Magenta Pink']
+    # colors_list = ['Gray', 'Red Orange', 'Yellow', 'Green', 'Light Blue',
+    #                'Blue', 'Purple', 'Pink']
+    colors_list = ['Gray', 'Red', 'Yellow', 'Green', 'Cyan',
+                   'Blue', 'Magenta']
     
     scores = []
     kwargs = {'CL method':['LR', 'SVM'], 'C':[0.1, 1], 'sign':[True, False], 

Home.py

@@ -6,24 +6,28 @@ st.set_page_config(layout='wide')
 
 st.title('About')
 
+st.subheader('General aim of the Ph.D. (to be updated)')
 # INTRO
-intro_text = """This project investigates the nature and nurture of latent spaces, with the aim of formulating a theory of this particular vectorial space. It draws together reflections on the inherent constraints of latent spaces in particular architectures and considers the learning-specific features that emerge.
+intro_text = """
+This project investigates the nature and nurture of latent spaces, with the aim of formulating a theory of this particular vectorial space. It draws together reflections on the inherent constraints of latent spaces in particular architectures and considers the learning-specific features that emerge.
 The thesis concentrates mostly on the second part, exploring different avenues for understanding the space. Using a multitude of vision generative models, it discusses possibilities for the systematic exploration of space, including disentanglement properties and coverage of various guidance methods.
 It also explores the possibility of comparison across latent spaces and investigates the differences and commonalities across different learning experiments. Furthermore, the thesis investigates the role of stochasticity in newer models.
 As a case study, this thesis adopts art historical data, spanning classic art, photography, and modern and contemporary art.
-
-The project aims to interpret the StyleGAN2 model by several techniques. 
-> “What concepts are disentangled in the latent space of StyleGAN2”\n
-> “Can we quantify the complexity of such concepts?”.
-
 """
 st.write(intro_text)
+st.subheader('On this experiment')
+st.write(
+"""The project aims to interpret the StyleGAN3 model trained on Textiles using disentanglement methods. 
+> “What features are disentangled in the latent space of StyleGAN3”\n
+> “Can we quantify the complexity, quality and relations of such features?”.
+""")
 
 # 4 PAGES
 st.subheader('Pages')
-sections_text = """Overall, there are x features in this web app:
-1) Disentanglement visualizer
-2) Concept vectors comparison and aggregation
+sections_text = """Overall, there are 3 features in this web app:
+1) Textiles manipulation 
+2) Features comparison 
+3) Vectors algebra manipulation
 ...
 """
 st.write(sections_text)

README.md

@@ -13,4 +13,5 @@ pinned: false
 
 To be change name: latent-space-theory
 
-This app was built with Streamlit. To run the app, `streamlit run Home.py` in the terminal.
+This app was built with Streamlit. To run the app, `streamlit run Home.py` in the terminal.
+python -m streamlit run Home.py

backend/disentangle_concepts.py

@@ -7,7 +7,7 @@ from PIL import Image
 
 
 
-def generate_composite_images(model, z, decision_boundaries, lambdas, latent_space='W'):
+def generate_composite_images(model, z, decision_boundaries, lambdas, latent_space='W', negative_colors=None):
     """
     The regenerate_images function takes a model, z, and decision_boundary as input.  It then
     constructs an inverse rotation/translation matrix and passes it to the generator.  The generator
@@ -33,9 +33,19 @@ def generate_composite_images(model, z, decision_boundaries, lambdas, latent_spa
     repetitions = 16 
     z_0 = z
     
-    for decision_boundary, lmbd in zip(decision_boundaries, lambdas):
-        decision_boundary = torch.from_numpy(decision_boundary.copy()).to(device)
-        z_0 = z_0 + int(lmbd) * decision_boundary
+    if negative_colors:
+        for decision_boundary, lmbd, neg_boundary in zip(decision_boundaries, lambdas, negative_colors):
+            decision_boundary = torch.from_numpy(decision_boundary.copy()).to(device)
+            if neg_boundary != 'None':
+                neg_boundary = torch.from_numpy(neg_boundary.copy()).to(device)
+            
+                z_0 = z_0 + int(lmbd) * (decision_boundary - (neg_boundary.T * decision_boundary) * neg_boundary)
+            else:
+                z_0 = z_0 + int(lmbd) * decision_boundary
+    else:            
+        for decision_boundary, lmbd in zip(decision_boundaries, lambdas):
+            decision_boundary = torch.from_numpy(decision_boundary.copy()).to(device)
+            z_0 = z_0 + int(lmbd) * decision_boundary
         
         
     if latent_space == 'Z':

config.toml

@@ -0,0 +1,8 @@
+[server]
+enableCORS = false
+headless = true
+
+[browser]
+serverAddress = 0.0.0.0
+gatherUsageStats = false
+serverPort = 8501

grammar_ornament_test.ipynb

@@ -0,0 +1,256 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os \n",
+    "from glob import glob \n",
+    "import pandas as pd\n",
+    "import numpy as np\n",
+    "\n",
+    "from PIL import Image, ImageColor\n",
+    "import extcolors\n",
+    "\n",
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "import torch\n",
+    "\n",
+    "import dnnlib \n",
+    "import legacy\n",
+    "\n",
+    "\n",
+    "%load_ext autoreload\n",
+    "%autoreload 2"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "images_textiles = glob('/Users/ludovicaschaerf/Desktop/TextAIles/TextileGAN/Original Textiles/*')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### LAWS\n",
+    "\n",
+    "1. primary colours on small surfaces and secondary or tertiary colors on large backgrounds\n",
+    "2. primary in upper portions and sec/third in lower portions of objects\n",
+    "3. primaries of equal intensities harmonize, secondaries harmonized by opposite primary in equal intensity, tertiary by remaining secondary\n",
+    "4. a full colors contrasted by a lower tone color should have the latter in larger proportion\n",
+    "5. when a primary has a hue (second coloration) of another primary, the secondary must have the hue of the third primary\n",
+    "6. blue in concave surfaces, yellow in convex, red in undersites\n",
+    "7. if too much of a color, the other colors should have the hue version without that color\n",
+    "8. all three primaries should be present\n",
+    "9. ..."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Test 1\n",
+    "\n",
+    "primary - secondary - tertiary "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def get_color_rank(hue, saturation, value):\n",
+    "    if value < 5:\n",
+    "        color = 'Black'\n",
+    "        rank = 'None'\n",
+    "    elif saturation < 3:\n",
+    "        color = 'White'\n",
+    "        rank = 'None'\n",
+    "    elif saturation < 15:\n",
+    "        color = 'Gray'\n",
+    "        rank = 'None'\n",
+    "    elif hue == 0:\n",
+    "        color = 'Gray'\n",
+    "        rank = 'None'\n",
+    "        \n",
+    "    elif hue >= 330 or hue <= 15:\n",
+    "        color = 'Red'\n",
+    "        rank = 'Primary'\n",
+    "    elif hue > 15 and hue < 25:\n",
+    "        color = 'Red Orange'\n",
+    "        rank = 'Tertiary'\n",
+    "    elif hue >= 25 and hue <= 40:\n",
+    "        color = 'Orange'\n",
+    "        rank = 'Secondary'\n",
+    "    elif hue > 40 and hue < 50:\n",
+    "        color = 'Orange Yellow'\n",
+    "        rank = 'Tertiary'\n",
+    "    elif hue >= 50 and hue <= 85:\n",
+    "        color = 'Yellow'\n",
+    "        rank = 'Primary'\n",
+    "    elif hue > 85 and hue < 95:\n",
+    "        color = 'Yellow Green'\n",
+    "        rank = 'Tertiary'\n",
+    "    elif hue >= 95 and hue <= 145:\n",
+    "        color = 'Green'\n",
+    "        rank = 'Secondary'\n",
+    "    elif hue >= 145 and hue < 180:\n",
+    "        color = 'Green Blue'\n",
+    "        rank = 'Tertiary'\n",
+    "    elif hue >= 180 and hue <= 245:\n",
+    "        color = 'Blue'\n",
+    "        rank = 'Primary'\n",
+    "    elif hue > 245 and hue < 265:\n",
+    "        color = 'Blue Violet'\n",
+    "        rank = 'Tertiary'\n",
+    "    elif hue >= 265 and hue <= 290:\n",
+    "        color = 'Violet'\n",
+    "        rank = 'Secondary'\n",
+    "    elif hue > 290 and hue < 330:\n",
+    "        color = 'Violet Red'\n",
+    "        rank = 'Tertiary'\n",
+    "    return color, rank"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def rgb2hsv(r, g, b):\n",
+    "    # Normalize R, G, B values\n",
+    "    r, g, b = r / 255.0, g / 255.0, b / 255.0\n",
+    "    \n",
+    "    # h, s, v = hue, saturation, value\n",
+    "    max_rgb = max(r, g, b)    \n",
+    "    min_rgb = min(r, g, b)   \n",
+    "    difference = max_rgb-min_rgb \n",
+    "    \n",
+    "    # if max_rgb and max_rgb are equal then h = 0\n",
+    "    if max_rgb == min_rgb:\n",
+    "        h = 0\n",
+    "    \n",
+    "    # if max_rgb==r then h is computed as follows\n",
+    "    elif max_rgb == r:\n",
+    "        h = (60 * ((g - b) / difference) + 360) % 360\n",
+    "    \n",
+    "    # if max_rgb==g then compute h as follows\n",
+    "    elif max_rgb == g:\n",
+    "        h = (60 * ((b - r) / difference) + 120) % 360\n",
+    "    \n",
+    "    # if max_rgb=b then compute h\n",
+    "    elif max_rgb == b:\n",
+    "        h = (60 * ((r - g) / difference) + 240) % 360\n",
+    "    \n",
+    "    # if max_rgb==zero then s=0\n",
+    "    if max_rgb == 0:\n",
+    "        s = 0\n",
+    "    else:\n",
+    "        s = (difference / max_rgb) * 100\n",
+    "    \n",
+    "    # compute v\n",
+    "    v = max_rgb * 100\n",
+    "    # return rounded values of H, S and V\n",
+    "    return tuple(map(round, (h, s, v)))\n",
+    " "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def obtain_hsv_colors(img):\n",
+    "    colors = extcolors.extract_from_path(img, tolerance=7, limit=7)\n",
+    "    colors = [(rgb2hsv(h[0][0], h[0][1], h[0][2]), h[1]) for h in colors[0] if h[0] != (0,0,0)]\n",
+    "    return colors"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "colors = obtain_hsv_colors(images_textiles[0])\n",
+    "print(colors)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for col in colors:\n",
+    "    print(get_color_rank(*col[0]))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for img in images_textiles[:30]:\n",
+    "    colors = obtain_hsv_colors(img)\n",
+    "    plt.imshow(plt.imread(img))\n",
+    "    plt.show()\n",
+    "    for col in colors:\n",
+    "        print(col[0])\n",
+    "        print(get_color_rank(*col[0]))\n",
+    "        \n",
+    "    print()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### use for training only images with medium saturation and value\n",
+    "\n",
+    "use codes and not only hue for color categorization\n",
+    "or remove colors that are creater with black and whites"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "art-reco_x86",
+   "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.8.16"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

interfacegan_colour_disentanglement.ipynb

@@ -15,6 +15,7 @@
     "\n",
     "from PIL import Image, ImageColor\n",
     "import matplotlib.pyplot as plt\n",
+    "from sklearn.model_selection import train_test_split\n",
     "\n",
     "import numpy as np\n",
     "import torch\n",
@@ -33,6 +34,87 @@
     "%autoreload 2"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "03efb8c0",
+   "metadata": {},
+   "source": [
+    "0-60\n",
+    "\n",
+    "Red\n",
+    "\n",
+    "60-120\n",
+    "\n",
+    "Yellow\n",
+    "\n",
+    "120-180\n",
+    "\n",
+    "Green\n",
+    "\n",
+    "180-240\n",
+    "\n",
+    "Cyan\n",
+    "\n",
+    "240-300\n",
+    "\n",
+    "Blue\n",
+    "\n",
+    "300-360\n",
+    "\n",
+    "Magenta\n",
+    "\n",
+    "Standard classification"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "00a35126",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def hex2rgb(hex_value):\n",
+    "    h = hex_value.strip(\"#\") \n",
+    "    rgb = tuple(int(h[i:i+2], 16) for i in (0, 2, 4))\n",
+    "    return rgb\n",
+    "\n",
+    "def rgb2hsv(r, g, b):\n",
+    "    # Normalize R, G, B values\n",
+    "    r, g, b = r / 255.0, g / 255.0, b / 255.0\n",
+    "    \n",
+    "    # h, s, v = hue, saturation, value\n",
+    "    max_rgb = max(r, g, b)    \n",
+    "    min_rgb = min(r, g, b)   \n",
+    "    difference = max_rgb-min_rgb \n",
+    "    \n",
+    "    # if max_rgb and max_rgb are equal then h = 0\n",
+    "    if max_rgb == min_rgb:\n",
+    "        h = 0\n",
+    "    \n",
+    "    # if max_rgb==r then h is computed as follows\n",
+    "    elif max_rgb == r:\n",
+    "        h = (60 * ((g - b) / difference) + 360) % 360\n",
+    "    \n",
+    "    # if max_rgb==g then compute h as follows\n",
+    "    elif max_rgb == g:\n",
+    "        h = (60 * ((b - r) / difference) + 120) % 360\n",
+    "    \n",
+    "    # if max_rgb=b then compute h\n",
+    "    elif max_rgb == b:\n",
+    "        h = (60 * ((r - g) / difference) + 240) % 360\n",
+    "    \n",
+    "    # if max_rgb==zero then s=0\n",
+    "    if max_rgb == 0:\n",
+    "        s = 0\n",
+    "    else:\n",
+    "        s = (difference / max_rgb) * 100\n",
+    "    \n",
+    "    # compute v\n",
+    "    v = max_rgb * 100\n",
+    "    # return rounded values of H, S and V\n",
+    "    return tuple(map(round, (h, s, v)))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -43,6 +125,21 @@
     "num_colors = 7"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c8428918",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "bins = [(x-1) * 360 / (num_colors - 1)  if x != 1 \n",
+    "             else 1 for x in range(num_colors + 1)]\n",
+    "bins[0] = 0\n",
+    "\n",
+    "bins\n",
+    "            "
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -50,8 +147,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "values = [x*256/num_colors if x<num_colors else 256 for x in range(num_colors + 1)]\n",
-    "centers = [int((values[i-1]+values[i])/2) for i in range(len(values)) if i > 0]"
+    "centers = [int((bins[i-1]+bins[i])/2) for i in range(len(bins)) if i > 0]"
    ]
   },
   {
@@ -61,7 +157,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "print(values)\n",
+    "print(bins)\n",
     "print(centers)"
    ]
   },
@@ -100,9 +196,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def to_256(val):\n",
-    "    x = val*360/256\n",
-    "    return x"
+    "# def to_256(val):\n",
+    "#     x = val*360/256\n",
+    "#     return int(x)"
    ]
   },
   {
@@ -112,9 +208,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "names = ['Red', 'Orange', 'Yellow', 'Yellow Green', 'Chartreuse Green',\n",
-    "         'Kelly Green', 'Green Blue Seafoam', 'Cyan Blue',\n",
-    "         'Warm Blue', 'Indigo', 'Purple Magenta', 'Magenta Pink']"
+    "names = ['Gray', 'Red', 'Yellow', 'Green', 'Cyan', 'Blue','Magenta']"
    ]
   },
   {
@@ -127,7 +221,7 @@
     "saturation = 1  # Saturation value (0 to 1)\n",
     "value = 1  # Value (brightness) value (0 to 1)\n",
     "for hue, name in zip(centers, names[:num_colors]):\n",
-    "    image = create_color_image(to_256(hue), saturation, value)\n",
+    "    image = create_color_image(hue, saturation, value)\n",
     "    display_image(image, name)  # Display the generated color image"
    ]
   },
@@ -148,6 +242,37 @@
     "    model = legacy.load_network_pkl(f)['G_ema'].to('cpu') # type: ignore\n"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "065cd656",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from DisentanglementBase import DisentanglementBase"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "afb8a611",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "variable = 'H1'\n",
+    "disentanglemnet_exp = DisentanglementBase('.', model, annotations, ann_df, space='W', colors_list=names, compute_s=False, variable=variable)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a7398217",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ann_df = disentanglemnet_exp.df"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -155,7 +280,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "ann_df = tohsv(ann_df)\n",
     "ann_df.head()"
    ]
   },
@@ -291,9 +415,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "colors_list = ['Warm Pink Red', 'Red Orange', 'Orange Yellow', 'Gold Yellow', 'Chartreuse Green',\n",
-    "               'Kelly Green', 'Green Blue Seafoam', 'Blue Green Cyan',\n",
-    "               'Warm Blue', 'Indigo Blue Purple', 'Purple Magenta', 'Magenta Pink']"
+    "colors_list = names"
    ]
   },
   {
@@ -313,10 +435,17 @@
    "source": [
     "from sklearn import svm\n",
     "\n",
-    "print([int(x*256/12) if x<12 else 255 for x in range(13)])\n",
-    "y_h_cat = pd.cut(y_h,bins=[x*256/12 if x<12 else 256 for x in range(13)],labels=colors_list).fillna('Warm Pink Red')\n",
+    "y_h_cat = pd.cut(y_h,bins=bins,labels=colors_list, include_lowest=True)\n",
     "\n",
     "print(y_h_cat.value_counts(dropna=False))\n",
+    "\n",
+    "y_h_cat[y_s == 0] = 'Gray'\n",
+    "y_h_cat[y_s == 100] = 'Gray'\n",
+    "y_h_cat[y_v == 0] = 'Gray'\n",
+    "y_h_cat[y_v == 100] = 'Gray'\n",
+    "\n",
+    "print(y_h_cat.value_counts(dropna=False))\n",
+    "\n",
     "x_trainhc, x_valhc, y_trainhc, y_valhc = train_test_split(X, y_h_cat, test_size=0.2)"
    ]
   },

pages/{1_Textiles_Disentanglement.py → 1_Textiles_Manipulation.py}

@@ -20,10 +20,14 @@ BACKGROUND_COLOR = '#bcd0e7'
 SECONDARY_COLOR = '#bce7db'
 
 
-st.title('Disentanglement studies on the Textile Dataset')
+st.title('Disentanglement on Textile Datasets')
 st.markdown(
     """
-    This is a demo of the Disentanglement studies on the [iMET Textiles Dataset](https://www.metmuseum.org/art/collection/search/85531).
+    This is a demo of the Disentanglement experiment on the [iMET Textiles Dataset](https://www.metmuseum.org/art/collection/search/85531).
+    
+    In this page, the user can adjust the colors of textile images generated by an AI by simply traversing the latent space of the AI. 
+    The colors can be adjusted following the human-intuitive encoding of HSV, adjusting the main Hue of the image with an option of 7 colors + Gray,
+    the saturation (the amount of Gray) and the value of the image (the amount of Black).
     """,
     unsafe_allow_html=False,)
     
@@ -49,7 +53,7 @@ with dnnlib.util.open_url('./data/textile_model_files/network-snapshot-005000.pk
 COLORS_LIST = ['Gray', 'Red Orange', 'Yellow', 'Green', 'Light Blue', 'Blue', 'Purple', 'Pink']
 
 if 'image_id' not in st.session_state:
-    st.session_state.image_id = 0
+    st.session_state.image_id = 52921
 if 'color_ids' not in st.session_state:
     st.session_state.concept_ids = COLORS_LIST[-1]
 if 'space_id' not in st.session_state:
@@ -73,9 +77,6 @@ if 'num_factors' not in st.session_state:
 if 'best' not in st.session_state:
     st.session_state.best = True
     
-# def on_change_random_input():
-#     st.session_state.image_id = st.session_state.image_id
-
 # ----------------------------- INPUT ----------------------------------
 st.header('Input')
 input_col_1, input_col_2, input_col_3, input_col_4 = st.columns(4)
@@ -83,8 +84,7 @@ input_col_1, input_col_2, input_col_3, input_col_4 = st.columns(4)
 with input_col_1:
    with st.form('image_form'):
         
-        # image_id = st.number_input('Image ID: ', format='%d', step=1)
-        st.write('**Choose or generate a random image to test the disentanglement**')
+        st.write('**Choose or generate a random base image**')
         chosen_image_id_input = st.empty()
         image_id = chosen_image_id_input.number_input('Image ID:', format='%d', step=1, value=st.session_state.image_id)
         
@@ -103,16 +103,15 @@ with input_col_1:
 with input_col_2:
     with st.form('text_form_1'):
         
-        st.write('**Choose color to vary**')
-        type_col = st.selectbox('Color:', tuple(COLORS_LIST), index=7)
-        colors_button = st.form_submit_button('Choose the defined color')
+        st.write('**Choose hue to vary**')
+        type_col = st.selectbox('Hue:', tuple(COLORS_LIST), index=7)
         
         st.write('**Set range of change**')
         chosen_color_lambda_input = st.empty()
         color_lambda = chosen_color_lambda_input.number_input('Lambda:', min_value=-100, step=1, value=7)
-        color_lambda_button = st.form_submit_button('Choose the defined lambda for color')
+        color_lambda_button = st.form_submit_button('Choose the defined hue and lambda')
           
-        if colors_button or color_lambda_button:
+        if color_lambda_button:
             st.session_state.image_id = image_id
             st.session_state.concept_ids = type_col
             st.session_state.color_lambda = color_lambda
@@ -121,45 +120,48 @@ with input_col_2:
 with input_col_3:
     with st.form('text_form'):
         
-        st.write('**Saturation variation**')
+        st.write('**Choose saturation variation**')
         chosen_saturation_lambda_input = st.empty()
         saturation_lambda = chosen_saturation_lambda_input.number_input('Lambda:', min_value=-100, step=1, key=0, value=0)
-        saturation_lambda_button = st.form_submit_button('Choose the defined lambda for saturation')
         
-        st.write('**Value variation**')
+        st.write('**Choose value variation**')
         chosen_value_lambda_input = st.empty()
         value_lambda = chosen_value_lambda_input.number_input('Lambda:', min_value=-100, step=1, key=1, value=0)
-        value_lambda_button = st.form_submit_button('Choose the defined lambda for salue')
+        value_lambda_button = st.form_submit_button('Choose the defined lambda for value and saturation')
         
-        if saturation_lambda_button or value_lambda_button:
+        if value_lambda_button:
             st.session_state.saturation_lambda = int(saturation_lambda)
             st.session_state.value_lambda = int(value_lambda)
             
 with input_col_4:         
     with st.form('text_form_2'):
-        st.write('Use best options')
+        st.write('Use the best vectors (after hyperparameter tuning)')
         best = st.selectbox('Option:', tuple([True, False]), index=0)
-        st.write('Options for StyleSpace (not available for Saturation and Value)')
-        sign = st.selectbox('Sign option:', tuple([True, False]), index=1)
-        num_factors = st.selectbox('Number of factors option:', tuple([1, 5, 10, 20, False]), index=4)
-        st.write('Options for InterFaceGAN (not available for Saturation and Value)')
-        cl_method = st.selectbox('Classification method option:', tuple(['LR', 'SVM', False]), index=2)
-        regularization = st.selectbox('Regularization option:', tuple([0.1, 1.0, False]), index=2)
-        st.write('Options for InterFaceGAN (only for Saturation and Value)')
-        extremes = st.selectbox('Extremes option:', tuple([True, False]), index=1)
-        
+        sign = True
+        num_factors=10
+        cl_method='LR'
+        regularization=0.1
+        extremes=True
+        if st.session_state.best is False:
+            st.write('Options for StyleSpace (not available for Saturation and Value)')
+            sign = st.selectbox('Sign option:', tuple([True, False]), index=1)
+            num_factors = st.selectbox('Number of factors option:', tuple([1, 5, 10, 20, False]), index=4)
+            st.write('Options for InterFaceGAN (not available for Saturation and Value)')
+            cl_method = st.selectbox('Classification method option:', tuple(['LR', 'SVM', False]), index=2)
+            regularization = st.selectbox('Regularization option:', tuple([0.1, 1.0, False]), index=2)
+            st.write('Options for InterFaceGAN (only for Saturation and Value)')
+            extremes = st.selectbox('Extremes option:', tuple([True, False]), index=1)
+            
         choose_options_button = st.form_submit_button('Choose the defined options')
-        # st.write('**Choose a latent space to disentangle**')
-        # # chosen_text_id_input = st.empty()
-        # # concept_id = chosen_text_id_input.text_input('Concept:', value=st.session_state.concept_id)
-        # space_id = st.selectbox('Space:', tuple(['Z', 'W']))
         if choose_options_button:
-            st.session_state.sign = sign
-            st.session_state.num_factors = num_factors
-            st.session_state.cl_method = cl_method
-            st.session_state.regularization = regularization
-            st.session_state.extremes = extremes
             st.session_state.best = best
+            if st.session_state.best is False:
+                st.session_state.sign = sign
+                st.session_state.num_factors = num_factors
+                st.session_state.cl_method = cl_method
+                st.session_state.regularization = regularization
+                st.session_state.extremes = extremes
+                
     
 # with input_col_4:
 #     with st.form('Network specifics:'):
@@ -178,7 +180,7 @@ with input_col_4:
 # ---------------------------- SET UP OUTPUT ------------------------------
 epsilon_container = st.empty()
 st.header('Image Manipulation')
-st.subheader('Using selected directions')
+st.write('Using selected vectors to modify the original image...')
 
 header_col_1, header_col_2 = st.columns([1,1])
 output_col_1, output_col_2 = st.columns([1,1])
@@ -193,7 +195,7 @@ output_col_1, output_col_2 = st.columns([1,1])
 
 # ---------------------------- DISPLAY COL 1 ROW 1 ------------------------------
 with header_col_1:
-    st.write(f'Original image')
+    st.write(f'### Original image')
 
 with header_col_2:
     if st.session_state.best:
@@ -209,8 +211,15 @@ with header_col_2:
         tmp_sat = concept_vectors[concept_vectors['color'] == 'Saturation'][concept_vectors['extremes'] == st.session_state.extremes]
         saturation_separation_vector, performance_saturation = tmp_sat.reset_index().loc[0, ['vector', 'score']]
         
-    st.write(f'Change in {st.session_state.concept_ids} of {np.round(st.session_state.color_lambda, 2)}, in saturation of {np.round(st.session_state.saturation_lambda, 2)}, in value of {np.round(st.session_state.value_lambda, 2)}. - Performance color vector: {performance_color}, saturation vector: {performance_saturation/100}, value vector: {performance_value/100}')
-
+    st.write('### Modified image')
+    st.write(f"""
+            Change in hue: {st.session_state.concept_ids} of amount: {np.round(st.session_state.color_lambda, 2)}, 
+            in: saturation of amount: {np.round(st.session_state.saturation_lambda, 2)}, 
+            in: value of amount: {np.round(st.session_state.value_lambda, 2)}.\
+            Verification performance of hue vector: {performance_color}, 
+            saturation vector: {performance_saturation/100},
+            value vector: {performance_value/100}""")
+    
 # ---------------------------- DISPLAY COL 2 ROW 1 ------------------------------
 
 if st.session_state.space_id == 'Z':
@@ -226,3 +235,4 @@ with output_col_1:
 with output_col_2:
     image_updated = generate_composite_images(model, original_image_vec, [color_separation_vector, saturation_separation_vector, value_separation_vector], lambdas=[st.session_state.color_lambda, st.session_state.saturation_lambda, st.session_state.value_lambda])
     st.image(image_updated)
+    

pages/{2_Colours_comparison.py → 2_Network_comparison.py}

@@ -24,7 +24,11 @@ st.set_page_config(layout='wide')
 
 st.title('Comparison among color directions')
 st.write('> **How do the color directions relate to each other?**')
-st.write('> **What is their joint impact on the image?**')
+st.write("""
+         This page provides a simple network-based framework to inspect the vector similarity (cosine similarity) among the found color vectors.
+         The nodes are the colors chosen for comparison and the strength of the edge represents the similarity.
+         
+         """)
 
         
 annotations_file = './data/textile_annotated_files/seeds0000-100000_S.pkl'
@@ -46,10 +50,8 @@ with dnnlib.util.open_url('./data/textile_model_files/network-snapshot-005000.pk
 
 COLORS_LIST = ['Gray', 'Red Orange', 'Yellow', 'Green', 'Light Blue', 'Blue', 'Purple', 'Pink', 'Saturation', 'Value']
 
-if 'image_id' not in st.session_state:
-    st.session_state.image_id = 0
 if 'concept_ids' not in st.session_state:
-    st.session_state.concept_ids = [COLORS_LIST[-1], COLORS_LIST[-2], ]
+    st.session_state.concept_ids = COLORS_LIST
 if 'sign' not in st.session_state:
     st.session_state.sign = False
 if 'extremes' not in st.session_state:
@@ -60,10 +62,8 @@ if 'cl_method' not in st.session_state:
     st.session_state.cl_method = False
 if 'num_factors' not in st.session_state:
     st.session_state.num_factors = False
-
-
-if 'space_id' not in st.session_state:
-    st.session_state.space_id = 'W'
+if 'best' not in st.session_state:
+    st.session_state.best = True
 
 # ----------------------------- INPUT ----------------------------------
 st.header('Input')
@@ -76,7 +76,7 @@ with input_col_1:
         st.write('**Choose a series of colors to compare**')
         # chosen_text_id_input = st.empty()
         # concept_id = chosen_text_id_input.text_input('Concept:', value=st.session_state.concept_id)
-        concept_ids = st.multiselect('Color (including Saturation and Value):', tuple(COLORS_LIST), default=[COLORS_LIST[-1], COLORS_LIST[-2], ])
+        concept_ids = st.multiselect('Color (including Saturation and Value):', tuple(COLORS_LIST), default=COLORS_LIST)
         choose_text_button = st.form_submit_button('Choose the defined colors')
         
         if choose_text_button:
@@ -85,27 +85,33 @@ with input_col_1:
             
 with input_col_2:
     with st.form('text_form_1'):
-        st.write('Options for StyleSpace (not available for Saturation and Value)')
-        sign = st.selectbox('Sign option:', tuple([True, False]), index=1)
-        num_factors = st.selectbox('Number of factors option:', tuple([1, 5, 10, 20, False]), index=4)
-        st.write('Options for InterFaceGAN (not available for Saturation and Value)')
-        cl_method = st.selectbox('Classification method option:', tuple(['LR', 'SVM', False]), index=2)
-        regularization = st.selectbox('Regularization option:', tuple([0.1, 1.0, False]), index=2)
-        st.write('Options for InterFaceGAN (only for Saturation and Value)')
-        extremes = st.selectbox('Extremes option:', tuple([True, False]), index=1)
-        
+        st.write('Use the best vectors (after hyperparameter tuning)')
+        best = st.selectbox('Option:', tuple([True, False]), index=0)
+        sign = True
+        num_factors=10
+        cl_method='LR'
+        regularization=0.1
+        extremes=True
+        if st.session_state.best is False:
+            st.write('Options for StyleSpace (not available for Saturation and Value)')
+            sign = st.selectbox('Sign option:', tuple([True, False]), index=1)
+            num_factors = st.selectbox('Number of factors option:', tuple([1, 5, 10, 20, False]), index=4)
+            st.write('Options for InterFaceGAN (not available for Saturation and Value)')
+            cl_method = st.selectbox('Classification method option:', tuple(['LR', 'SVM', False]), index=2)
+            regularization = st.selectbox('Regularization option:', tuple([0.1, 1.0, False]), index=2)
+            st.write('Options for InterFaceGAN (only for Saturation and Value)')
+            extremes = st.selectbox('Extremes option:', tuple([True, False]), index=1)
+            
         choose_options_button = st.form_submit_button('Choose the defined options')
-        # st.write('**Choose a latent space to disentangle**')
-        # # chosen_text_id_input = st.empty()
-        # # concept_id = chosen_text_id_input.text_input('Concept:', value=st.session_state.concept_id)
-        # space_id = st.selectbox('Space:', tuple(['Z', 'W']))
         if choose_options_button:
-            st.session_state.sign = sign
-            st.session_state.num_factors = num_factors
-            st.session_state.cl_method = cl_method
-            st.session_state.regularization = regularization
-            st.session_state.extremes = extremes
-            
+            st.session_state.best = best
+            if st.session_state.best is False:
+                st.session_state.sign = sign
+                st.session_state.num_factors = num_factors
+                st.session_state.cl_method = cl_method
+                st.session_state.regularization = regularization
+                st.session_state.extremes = extremes
+        
 # ---------------------------- SET UP OUTPUT ------------------------------
 epsilon_container = st.empty()
 st.header('Comparison')
@@ -115,23 +121,28 @@ header_col_1, header_col_2 = st.columns([3,1])
 output_col_1, output_col_2 = st.columns([3,1])
 
 # ---------------------------- DISPLAY COL 1 ROW 1 ------------------------------
-tmp = concept_vectors[concept_vectors['color'].isin(st.session_state.concept_ids)]
-tmp = tmp[tmp['sign'] == st.session_state.sign][tmp['extremes'] == st.session_state.extremes][tmp['num_factors'] == st.session_state.num_factors][tmp['cl_method'] == st.session_state.cl_method][tmp['regularization'] == st.session_state.regularization]
+if st.session_state.best:
+    tmp = concept_vectors[concept_vectors['color'].isin(st.session_state.concept_ids)].groupby('color').first().reset_index()
+else:
+    tmp = concept_vectors[concept_vectors['color'].isin(st.session_state.concept_ids)]
+    tmp = tmp[tmp['sign'] == st.session_state.sign][tmp['extremes'] == st.session_state.extremes][tmp['num_factors'] == st.session_state.num_factors][tmp['cl_method'] == st.session_state.cl_method][tmp['regularization'] == st.session_state.regularization]
+
 info = tmp.loc[:, ['vector', 'score', 'color', 'kwargs']].values
 concept_ids = [i[2] for i in info] #+ ' ' + i[3]
     
 with header_col_1:
-    st.write('Similarity graph')
+    st.write('### Similarity graph')
 
 with header_col_2:
-    st.write('Information')
+    st.write('### Information')
     
 with output_col_2:
     for i,concept_id in enumerate(concept_ids):
-        st.write(f'Color {info[i][2]} - Settings: {info[i][3]} Performance of the color vector: {info[i][1]}')# - Nodes {",".join(list(imp_nodes))}')
+        st.write(f'''Color: {info[i][2]}.\
+                     Settings: {info[i][3]}\
+                     ''')
 
 with output_col_1:
-    
     edges = []
     for i in range(len(concept_ids)):
         for j in range(len(concept_ids)):

pages/3_Vectors_algebra.py

@@ -0,0 +1,163 @@
+import streamlit as st
+import pickle
+import pandas as pd
+import numpy as np
+import random
+import torch
+
+from matplotlib.backends.backend_agg import RendererAgg
+
+from backend.disentangle_concepts import *
+import torch_utils
+import dnnlib
+import legacy
+
+_lock = RendererAgg.lock
+
+
+st.set_page_config(layout='wide')
+BACKGROUND_COLOR = '#bcd0e7'
+SECONDARY_COLOR = '#bce7db'
+
+
+st.title('Vector algebra using disentangled vectors')
+st.markdown(
+    """
+    This page offers the possibility to edit the colors of a given textile image using vector algebra and projections.
+    It allows to select several colors to move towards and against (selecting a positive or negative lambda). 
+    Furthermore, it offers the possibility of conditional manipulation, by moving in the direction of a color n1 without affecting the color n2. 
+    This is done using a projected direction n1 - (n1.T n2) n2. 
+    """,
+    unsafe_allow_html=False,)
+    
+annotations_file = './data/textile_annotated_files/seeds0000-100000_S.pkl'
+with open(annotations_file, 'rb') as f:
+    annotations = pickle.load(f)
+
+concept_vectors = pd.read_csv('./data/stored_vectors/scores_colors_hsv.csv')
+concept_vectors['vector'] = [np.array([float(xx) for xx in x]) for x in concept_vectors['vector'].str.split(', ')]
+concept_vectors['score'] = concept_vectors['score'].astype(float)
+
+concept_vectors = concept_vectors.sort_values('score', ascending=False).reset_index()
+
+with dnnlib.util.open_url('./data/textile_model_files/network-snapshot-005000.pkl') as f:
+    model = legacy.load_network_pkl(f)['G_ema'].to('cpu') # type: ignore
+
+COLORS_LIST = ['Gray', 'Red Orange', 'Yellow', 'Green', 'Light Blue', 'Blue', 'Purple', 'Pink', 'Saturation', 'Value']
+COLORS_NEGATIVE = COLORS_LIST + ['None']
+
+if 'image_id' not in st.session_state:
+    st.session_state.image_id = 52921
+if 'colors' not in st.session_state:
+    st.session_state.colors = [COLORS_LIST[5], COLORS_LIST[7]]
+if 'non_colors' not in st.session_state:
+    st.session_state.non_colors = ['None']
+if 'color_lambda' not in st.session_state:
+    st.session_state.color_lambda = [5]
+
+# ----------------------------- INPUT ----------------------------------
+epsilon_container = st.empty()
+st.header('Image Manipulation with Vector Algebra')
+
+header_col_1, header_col_2, header_col_3, header_col_4 = st.columns([1,1,1,1])
+input_col_1, output_col_2, output_col_3, input_col_4 = st.columns([1,1,1,1])
+
+# --------------------------- INPUT column 1 ---------------------------
+with input_col_1:
+   with st.form('image_form'):
+        
+        # image_id = st.number_input('Image ID: ', format='%d', step=1)
+        st.write('**Choose or generate a random image**')
+        chosen_image_id_input = st.empty()
+        image_id = chosen_image_id_input.number_input('Image ID:', format='%d', step=1, value=st.session_state.image_id)
+        
+        choose_image_button = st.form_submit_button('Choose the defined image')
+        random_id = st.form_submit_button('Generate a random image')
+
+        if random_id:
+            image_id = random.randint(0, 100000)
+            st.session_state.image_id = image_id
+            chosen_image_id_input.number_input('Image ID:', format='%d', step=1, value=st.session_state.image_id)
+            
+        if choose_image_button:
+            image_id = int(image_id)
+            st.session_state.image_id = image_id
+
+with header_col_1:
+    st.write('### Input image selection')
+
+original_image_vec = annotations['w_vectors'][st.session_state.image_id]
+img = generate_original_image(original_image_vec, model)
+
+with output_col_2:
+    st.image(img)
+
+with header_col_2:
+    st.write('### Original image')
+    
+with input_col_4:
+    with st.form('text_form_1'):
+        
+        st.write('**Colors to vary (including Saturation and Value)**')
+        colors = st.multiselect('Color:', tuple(COLORS_LIST), default=[COLORS_LIST[5], COLORS_LIST[7]])
+        colors_button = st.form_submit_button('Choose the defined colors')
+        
+        st.session_state.image_id = image_id
+        st.session_state.colors = colors
+        st.session_state.color_lambda = [5]*len(colors)
+        st.session_state.non_colors = ['None']*len(colors)
+            
+        lambdas = []
+        negative_cols = []
+        for color in colors:
+            st.write('### '+color )
+            st.write('**Set range of change (can be negative)**')
+            chosen_color_lambda_input = st.empty()
+            color_lambda = chosen_color_lambda_input.number_input('Lambda:', min_value=-100, step=1, value=5, key=color+'_number')
+            lambdas.append(color_lambda)
+                
+            st.write('**Set dimensions of change to not consider**')
+            chosen_color_negative_input = st.empty()
+            color_negative = chosen_color_negative_input.selectbox('Color:', tuple(COLORS_NEGATIVE), index=len(COLORS_NEGATIVE)-1, key=color+'_noncolor')
+            negative_cols.append(color_negative)
+                
+        lambdas_button = st.form_submit_button('Submit options')
+        if lambdas_button:
+            st.session_state.color_lambda = lambdas
+            st.session_state.non_colors = negative_cols
+                
+        
+with header_col_4:
+    st.write('### Color settings')
+# print(st.session_state.colors)
+# print(st.session_state.color_lambda)
+# print(st.session_state.non_colors)
+
+# ---------------------------- DISPLAY COL 1 ROW 1 ------------------------------
+
+with header_col_3:
+    separation_vectors = []
+    for col in st.session_state.colors:
+        separation_vector, score_1 = concept_vectors[concept_vectors['color'] == col].reset_index().loc[0, ['vector', 'score']]
+        separation_vectors.append(separation_vector)
+    
+    negative_separation_vectors = []
+    for non_col in st.session_state.non_colors:
+        if non_col != 'None':
+            negative_separation_vector, score_2 = concept_vectors[concept_vectors['color'] == non_col].reset_index().loc[0, ['vector', 'score']]
+            negative_separation_vectors.append(negative_separation_vector)
+        else:
+            negative_separation_vectors.append('None')
+    ## n1 − (n1T n2)n2
+    # print(negative_separation_vectors, separation_vectors)
+    st.write('### Output Image')
+    st.write(f'''Change in colors: {str(st.session_state.colors)},\
+             without affecting colors {str(st.session_state.non_colors)}''')
+
+# ---------------------------- DISPLAY COL 2 ROW 1 ------------------------------
+
+with output_col_3:
+    image_updated = generate_composite_images(model, original_image_vec, separation_vectors, 
+                                              lambdas=st.session_state.color_lambda, 
+                                              negative_colors=negative_separation_vectors)
+    st.image(image_updated)

test-docker.sh

@@ -0,0 +1,743 @@
+#!/bin/sh
+set -e
+# Docker Engine for Linux installation script.
+#
+# This script is intended as a convenient way to configure docker's package
+# repositories and to install Docker Engine, This script is not recommended
+# for production environments. Before running this script, make yourself familiar
+# with potential risks and limitations, and refer to the installation manual
+# at https://docs.docker.com/engine/install/ for alternative installation methods.
+#
+# The script:
+#
+# - Requires `root` or `sudo` privileges to run.
+# - Attempts to detect your Linux distribution and version and configure your
+#   package management system for you.
+# - Doesn't allow you to customize most installation parameters.
+# - Installs dependencies and recommendations without asking for confirmation.
+# - Installs the latest stable release (by default) of Docker CLI, Docker Engine,
+#   Docker Buildx, Docker Compose, containerd, and runc. When using this script
+#   to provision a machine, this may result in unexpected major version upgrades
+#   of these packages. Always test upgrades in a test environment before
+#   deploying to your production systems.
+# - Isn't designed to upgrade an existing Docker installation. When using the
+#   script to update an existing installation, dependencies may not be updated
+#   to the expected version, resulting in outdated versions.
+#
+# Source code is available at https://github.com/docker/docker-install/
+#
+# Usage
+# ==============================================================================
+#
+# To install the latest stable versions of Docker CLI, Docker Engine, and their
+# dependencies:
+#
+# 1. download the script
+#
+#   $ curl -fsSL https://get.docker.com -o install-docker.sh
+#
+# 2. verify the script's content
+#
+#   $ cat install-docker.sh
+#
+# 3. run the script with --dry-run to verify the steps it executes
+#
+#   $ sh install-docker.sh --dry-run
+#
+# 4. run the script either as root, or using sudo to perform the installation.
+#
+#   $ sudo sh install-docker.sh
+#
+# Command-line options
+# ==============================================================================
+#
+# --version <VERSION>
+# Use the --version option to install a specific version, for example:
+#
+#   $ sudo sh install-docker.sh --version 23.0
+#
+# --channel <stable|test>
+#
+# Use the --channel option to install from an alternative installation channel.
+# The following example installs the latest versions from the "test" channel,
+# which includes pre-releases (alpha, beta, rc):
+#
+#   $ sudo sh install-docker.sh --channel test
+#
+# Alternatively, use the script at https://test.docker.com, which uses the test
+# channel as default.
+#
+# --mirror <Aliyun|AzureChinaCloud>
+#
+# Use the --mirror option to install from a mirror supported by this script.
+# Available mirrors are "Aliyun" (https://mirrors.aliyun.com/docker-ce), and
+# "AzureChinaCloud" (https://mirror.azure.cn/docker-ce), for example:
+#
+#   $ sudo sh install-docker.sh --mirror AzureChinaCloud
+#
+# ==============================================================================
+
+
+# Git commit from https://github.com/docker/docker-install when
+# the script was uploaded (Should only be modified by upload job):
+SCRIPT_COMMIT_SHA="e5543d473431b782227f8908005543bb4389b8de"
+
+# strip "v" prefix if present
+VERSION="${VERSION#v}"
+
+# The channel to install from:
+#   * stable
+#   * test
+#   * edge (deprecated)
+#   * nightly (deprecated)
+DEFAULT_CHANNEL_VALUE="test"
+if [ -z "$CHANNEL" ]; then
+	CHANNEL=$DEFAULT_CHANNEL_VALUE
+fi
+
+DEFAULT_DOWNLOAD_URL="https://download.docker.com"
+if [ -z "$DOWNLOAD_URL" ]; then
+	DOWNLOAD_URL=$DEFAULT_DOWNLOAD_URL
+fi
+
+DEFAULT_REPO_FILE="docker-ce.repo"
+if [ -z "$REPO_FILE" ]; then
+	REPO_FILE="$DEFAULT_REPO_FILE"
+fi
+
+mirror=''
+DRY_RUN=${DRY_RUN:-}
+while [ $# -gt 0 ]; do
+	case "$1" in
+		--channel)
+			CHANNEL="$2"
+			shift
+			;;
+		--dry-run)
+			DRY_RUN=1
+			;;
+		--mirror)
+			mirror="$2"
+			shift
+			;;
+		--version)
+			VERSION="${2#v}"
+			shift
+			;;
+		--*)
+			echo "Illegal option $1"
+			;;
+	esac
+	shift $(( $# > 0 ? 1 : 0 ))
+done
+
+case "$mirror" in
+	Aliyun)
+		DOWNLOAD_URL="https://mirrors.aliyun.com/docker-ce"
+		;;
+	AzureChinaCloud)
+		DOWNLOAD_URL="https://mirror.azure.cn/docker-ce"
+		;;
+	"")
+		;;
+	*)
+		>&2 echo "unknown mirror '$mirror': use either 'Aliyun', or 'AzureChinaCloud'."
+		exit 1
+		;;
+esac
+
+case "$CHANNEL" in
+	stable|test)
+		;;
+	edge|nightly)
+		>&2 echo "DEPRECATED: the $CHANNEL channel has been deprecated and is no longer supported by this script."
+		exit 1
+		;;
+	*)
+		>&2 echo "unknown CHANNEL '$CHANNEL': use either stable or test."
+		exit 1
+		;;
+esac
+
+command_exists() {
+	command -v "$@" > /dev/null 2>&1
+}
+
+# version_gte checks if the version specified in $VERSION is at least the given
+# SemVer (Maj.Minor[.Patch]), or CalVer (YY.MM) version.It returns 0 (success)
+# if $VERSION is either unset (=latest) or newer or equal than the specified
+# version, or returns 1 (fail) otherwise.
+#
+# examples:
+#
+# VERSION=23.0
+# version_gte 23.0  // 0 (success)
+# version_gte 20.10 // 0 (success)
+# version_gte 19.03 // 0 (success)
+# version_gte 21.10 // 1 (fail)
+version_gte() {
+	if [ -z "$VERSION" ]; then
+			return 0
+	fi
+	eval version_compare "$VERSION" "$1"
+}
+
+# version_compare compares two version strings (either SemVer (Major.Minor.Path),
+# or CalVer (YY.MM) version strings. It returns 0 (success) if version A is newer
+# or equal than version B, or 1 (fail) otherwise. Patch releases and pre-release
+# (-alpha/-beta) are not taken into account
+#
+# examples:
+#
+# version_compare 23.0.0 20.10 // 0 (success)
+# version_compare 23.0 20.10   // 0 (success)
+# version_compare 20.10 19.03  // 0 (success)
+# version_compare 20.10 20.10  // 0 (success)
+# version_compare 19.03 20.10  // 1 (fail)
+version_compare() (
+	set +x
+
+	yy_a="$(echo "$1" | cut -d'.' -f1)"
+	yy_b="$(echo "$2" | cut -d'.' -f1)"
+	if [ "$yy_a" -lt "$yy_b" ]; then
+		return 1
+	fi
+	if [ "$yy_a" -gt "$yy_b" ]; then
+		return 0
+	fi
+	mm_a="$(echo "$1" | cut -d'.' -f2)"
+	mm_b="$(echo "$2" | cut -d'.' -f2)"
+
+	# trim leading zeros to accommodate CalVer
+	mm_a="${mm_a#0}"
+	mm_b="${mm_b#0}"
+
+	if [ "${mm_a:-0}" -lt "${mm_b:-0}" ]; then
+		return 1
+	fi
+
+	return 0
+)
+
+is_dry_run() {
+	if [ -z "$DRY_RUN" ]; then
+		return 1
+	else
+		return 0
+	fi
+}
+
+is_wsl() {
+	case "$(uname -r)" in
+	*microsoft* ) true ;; # WSL 2
+	*Microsoft* ) true ;; # WSL 1
+	* ) false;;
+	esac
+}
+
+is_darwin() {
+	case "$(uname -s)" in
+	*darwin* ) true ;;
+	*Darwin* ) true ;;
+	* ) false;;
+	esac
+}
+
+deprecation_notice() {
+	distro=$1
+	distro_version=$2
+	echo
+	printf "\033[91;1mDEPRECATION WARNING\033[0m\n"
+	printf "    This Linux distribution (\033[1m%s %s\033[0m) reached end-of-life and is no longer supported by this script.\n" "$distro" "$distro_version"
+	echo   "    No updates or security fixes will be released for this distribution, and users are recommended"
+	echo   "    to upgrade to a currently maintained version of $distro."
+	echo
+	printf   "Press \033[1mCtrl+C\033[0m now to abort this script, or wait for the installation to continue."
+	echo
+	sleep 10
+}
+
+get_distribution() {
+	lsb_dist=""
+	# Every system that we officially support has /etc/os-release
+	if [ -r /etc/os-release ]; then
+		lsb_dist="$(. /etc/os-release && echo "$ID")"
+	fi
+	# Returning an empty string here should be alright since the
+	# case statements don't act unless you provide an actual value
+	echo "$lsb_dist"
+}
+
+echo_docker_as_nonroot() {
+	if is_dry_run; then
+		return
+	fi
+	if command_exists docker && [ -e /var/run/docker.sock ]; then
+		(
+			set -x
+			$sh_c 'docker version'
+		) || true
+	fi
+
+	# intentionally mixed spaces and tabs here -- tabs are stripped by "<<-EOF", spaces are kept in the output
+	echo
+	echo "================================================================================"
+	echo
+	if version_gte "20.10"; then
+		echo "To run Docker as a non-privileged user, consider setting up the"
+		echo "Docker daemon in rootless mode for your user:"
+		echo
+		echo "    dockerd-rootless-setuptool.sh install"
+		echo
+		echo "Visit https://docs.docker.com/go/rootless/ to learn about rootless mode."
+		echo
+	fi
+	echo
+	echo "To run the Docker daemon as a fully privileged service, but granting non-root"
+	echo "users access, refer to https://docs.docker.com/go/daemon-access/"
+	echo
+	echo "WARNING: Access to the remote API on a privileged Docker daemon is equivalent"
+	echo "         to root access on the host. Refer to the 'Docker daemon attack surface'"
+	echo "         documentation for details: https://docs.docker.com/go/attack-surface/"
+	echo
+	echo "================================================================================"
+	echo
+}
+
+# Check if this is a forked Linux distro
+check_forked() {
+
+	# Check for lsb_release command existence, it usually exists in forked distros
+	if command_exists lsb_release; then
+		# Check if the `-u` option is supported
+		set +e
+		lsb_release -a -u > /dev/null 2>&1
+		lsb_release_exit_code=$?
+		set -e
+
+		# Check if the command has exited successfully, it means we're in a forked distro
+		if [ "$lsb_release_exit_code" = "0" ]; then
+			# Print info about current distro
+			cat <<-EOF
+			You're using '$lsb_dist' version '$dist_version'.
+			EOF
+
+			# Get the upstream release info
+			lsb_dist=$(lsb_release -a -u 2>&1 | tr '[:upper:]' '[:lower:]' | grep -E 'id' | cut -d ':' -f 2 | tr -d '[:space:]')
+			dist_version=$(lsb_release -a -u 2>&1 | tr '[:upper:]' '[:lower:]' | grep -E 'codename' | cut -d ':' -f 2 | tr -d '[:space:]')
+
+			# Print info about upstream distro
+			cat <<-EOF
+			Upstream release is '$lsb_dist' version '$dist_version'.
+			EOF
+		else
+			if [ -r /etc/debian_version ] && [ "$lsb_dist" != "ubuntu" ] && [ "$lsb_dist" != "raspbian" ]; then
+				if [ "$lsb_dist" = "osmc" ]; then
+					# OSMC runs Raspbian
+					lsb_dist=raspbian
+				else
+					# We're Debian and don't even know it!
+					lsb_dist=debian
+				fi
+				dist_version="$(sed 's/\/.*//' /etc/debian_version | sed 's/\..*//')"
+				case "$dist_version" in
+					12)
+						dist_version="bookworm"
+					;;
+					11)
+						dist_version="bullseye"
+					;;
+					10)
+						dist_version="buster"
+					;;
+					9)
+						dist_version="stretch"
+					;;
+					8)
+						dist_version="jessie"
+					;;
+				esac
+			fi
+		fi
+	fi
+}
+
+do_install() {
+	echo "# Executing docker install script, commit: $SCRIPT_COMMIT_SHA"
+
+	if command_exists docker; then
+		cat >&2 <<-'EOF'
+			Warning: the "docker" command appears to already exist on this system.
+
+			If you already have Docker installed, this script can cause trouble, which is
+			why we're displaying this warning and provide the opportunity to cancel the
+			installation.
+
+			If you installed the current Docker package using this script and are using it
+			again to update Docker, you can safely ignore this message.
+
+			You may press Ctrl+C now to abort this script.
+		EOF
+		( set -x; sleep 20 )
+	fi
+
+	user="$(id -un 2>/dev/null || true)"
+
+	sh_c='sh -c'
+	if [ "$user" != 'root' ]; then
+		if command_exists sudo; then
+			sh_c='sudo -E sh -c'
+		elif command_exists su; then
+			sh_c='su -c'
+		else
+			cat >&2 <<-'EOF'
+			Error: this installer needs the ability to run commands as root.
+			We are unable to find either "sudo" or "su" available to make this happen.
+			EOF
+			exit 1
+		fi
+	fi
+
+	if is_dry_run; then
+		sh_c="echo"
+	fi
+
+	# perform some very rudimentary platform detection
+	lsb_dist=$( get_distribution )
+	lsb_dist="$(echo "$lsb_dist" | tr '[:upper:]' '[:lower:]')"
+
+	if is_wsl; then
+		echo
+		echo "WSL DETECTED: We recommend using Docker Desktop for Windows."
+		echo "Please get Docker Desktop from https://www.docker.com/products/docker-desktop/"
+		echo
+		cat >&2 <<-'EOF'
+
+			You may press Ctrl+C now to abort this script.
+		EOF
+		( set -x; sleep 20 )
+	fi
+
+	case "$lsb_dist" in
+
+		ubuntu)
+			if command_exists lsb_release; then
+				dist_version="$(lsb_release --codename | cut -f2)"
+			fi
+			if [ -z "$dist_version" ] && [ -r /etc/lsb-release ]; then
+				dist_version="$(. /etc/lsb-release && echo "$DISTRIB_CODENAME")"
+			fi
+		;;
+
+		debian|raspbian)
+			dist_version="$(sed 's/\/.*//' /etc/debian_version | sed 's/\..*//')"
+			case "$dist_version" in
+				12)
+					dist_version="bookworm"
+				;;
+				11)
+					dist_version="bullseye"
+				;;
+				10)
+					dist_version="buster"
+				;;
+				9)
+					dist_version="stretch"
+				;;
+				8)
+					dist_version="jessie"
+				;;
+			esac
+		;;
+
+		centos|rhel|sles)
+			if [ -z "$dist_version" ] && [ -r /etc/os-release ]; then
+				dist_version="$(. /etc/os-release && echo "$VERSION_ID")"
+			fi
+		;;
+
+		*)
+			if command_exists lsb_release; then
+				dist_version="$(lsb_release --release | cut -f2)"
+			fi
+			if [ -z "$dist_version" ] && [ -r /etc/os-release ]; then
+				dist_version="$(. /etc/os-release && echo "$VERSION_ID")"
+			fi
+		;;
+
+	esac
+
+	# Check if this is a forked Linux distro
+	check_forked
+
+	# Print deprecation warnings for distro versions that recently reached EOL,
+	# but may still be commonly used (especially LTS versions).
+	case "$lsb_dist.$dist_version" in
+		debian.stretch|debian.jessie)
+			deprecation_notice "$lsb_dist" "$dist_version"
+			;;
+		raspbian.stretch|raspbian.jessie)
+			deprecation_notice "$lsb_dist" "$dist_version"
+			;;
+		ubuntu.xenial|ubuntu.trusty)
+			deprecation_notice "$lsb_dist" "$dist_version"
+			;;
+		ubuntu.impish|ubuntu.hirsute|ubuntu.groovy|ubuntu.eoan|ubuntu.disco|ubuntu.cosmic)
+			deprecation_notice "$lsb_dist" "$dist_version"
+			;;
+		fedora.*)
+			if [ "$dist_version" -lt 36 ]; then
+				deprecation_notice "$lsb_dist" "$dist_version"
+			fi
+			;;
+	esac
+
+	# Run setup for each distro accordingly
+	case "$lsb_dist" in
+		ubuntu|debian|raspbian)
+			pre_reqs="apt-transport-https ca-certificates curl"
+			if ! command -v gpg > /dev/null; then
+				pre_reqs="$pre_reqs gnupg"
+			fi
+			apt_repo="deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] $DOWNLOAD_URL/linux/$lsb_dist $dist_version $CHANNEL"
+			(
+				if ! is_dry_run; then
+					set -x
+				fi
+				$sh_c 'apt-get update -qq >/dev/null'
+				$sh_c "DEBIAN_FRONTEND=noninteractive apt-get install -y -qq $pre_reqs >/dev/null"
+				$sh_c 'install -m 0755 -d /etc/apt/keyrings'
+				$sh_c "curl -fsSL \"$DOWNLOAD_URL/linux/$lsb_dist/gpg\" | gpg --dearmor --yes -o /etc/apt/keyrings/docker.gpg"
+				$sh_c "chmod a+r /etc/apt/keyrings/docker.gpg"
+				$sh_c "echo \"$apt_repo\" > /etc/apt/sources.list.d/docker.list"
+				$sh_c 'apt-get update -qq >/dev/null'
+			)
+			pkg_version=""
+			if [ -n "$VERSION" ]; then
+				if is_dry_run; then
+					echo "# WARNING: VERSION pinning is not supported in DRY_RUN"
+				else
+					# Will work for incomplete versions IE (17.12), but may not actually grab the "latest" if in the test channel
+					pkg_pattern="$(echo "$VERSION" | sed 's/-ce-/~ce~.*/g' | sed 's/-/.*/g')"
+					search_command="apt-cache madison docker-ce | grep '$pkg_pattern' | head -1 | awk '{\$1=\$1};1' | cut -d' ' -f 3"
+					pkg_version="$($sh_c "$search_command")"
+					echo "INFO: Searching repository for VERSION '$VERSION'"
+					echo "INFO: $search_command"
+					if [ -z "$pkg_version" ]; then
+						echo
+						echo "ERROR: '$VERSION' not found amongst apt-cache madison results"
+						echo
+						exit 1
+					fi
+					if version_gte "18.09"; then
+							search_command="apt-cache madison docker-ce-cli | grep '$pkg_pattern' | head -1 | awk '{\$1=\$1};1' | cut -d' ' -f 3"
+							echo "INFO: $search_command"
+							cli_pkg_version="=$($sh_c "$search_command")"
+					fi
+					pkg_version="=$pkg_version"
+				fi
+			fi
+			(
+				pkgs="docker-ce${pkg_version%=}"
+				if version_gte "18.09"; then
+						# older versions didn't ship the cli and containerd as separate packages
+						pkgs="$pkgs docker-ce-cli${cli_pkg_version%=} containerd.io"
+				fi
+				if version_gte "20.10"; then
+						pkgs="$pkgs docker-compose-plugin docker-ce-rootless-extras$pkg_version"
+				fi
+				if version_gte "23.0"; then
+						pkgs="$pkgs docker-buildx-plugin"
+				fi
+				if ! is_dry_run; then
+					set -x
+				fi
+				$sh_c "DEBIAN_FRONTEND=noninteractive apt-get install -y -qq $pkgs >/dev/null"
+			)
+			echo_docker_as_nonroot
+			exit 0
+			;;
+		centos|fedora|rhel)
+			if [ "$(uname -m)" != "s390x" ] && [ "$lsb_dist" = "rhel" ]; then
+				echo "Packages for RHEL are currently only available for s390x."
+				exit 1
+			fi
+			if [ "$lsb_dist" = "fedora" ]; then
+				pkg_manager="dnf"
+				config_manager="dnf config-manager"
+				enable_channel_flag="--set-enabled"
+				disable_channel_flag="--set-disabled"
+				pre_reqs="dnf-plugins-core"
+				pkg_suffix="fc$dist_version"
+			else
+				pkg_manager="yum"
+				config_manager="yum-config-manager"
+				enable_channel_flag="--enable"
+				disable_channel_flag="--disable"
+				pre_reqs="yum-utils"
+				pkg_suffix="el"
+			fi
+			repo_file_url="$DOWNLOAD_URL/linux/$lsb_dist/$REPO_FILE"
+			(
+				if ! is_dry_run; then
+					set -x
+				fi
+				$sh_c "$pkg_manager install -y -q $pre_reqs"
+				$sh_c "$config_manager --add-repo $repo_file_url"
+
+				if [ "$CHANNEL" != "stable" ]; then
+					$sh_c "$config_manager $disable_channel_flag 'docker-ce-*'"
+					$sh_c "$config_manager $enable_channel_flag 'docker-ce-$CHANNEL'"
+				fi
+				$sh_c "$pkg_manager makecache"
+			)
+			pkg_version=""
+			if [ -n "$VERSION" ]; then
+				if is_dry_run; then
+					echo "# WARNING: VERSION pinning is not supported in DRY_RUN"
+				else
+					pkg_pattern="$(echo "$VERSION" | sed 's/-ce-/\\\\.ce.*/g' | sed 's/-/.*/g').*$pkg_suffix"
+					search_command="$pkg_manager list --showduplicates docker-ce | grep '$pkg_pattern' | tail -1 | awk '{print \$2}'"
+					pkg_version="$($sh_c "$search_command")"
+					echo "INFO: Searching repository for VERSION '$VERSION'"
+					echo "INFO: $search_command"
+					if [ -z "$pkg_version" ]; then
+						echo
+						echo "ERROR: '$VERSION' not found amongst $pkg_manager list results"
+						echo
+						exit 1
+					fi
+					if version_gte "18.09"; then
+						# older versions don't support a cli package
+						search_command="$pkg_manager list --showduplicates docker-ce-cli | grep '$pkg_pattern' | tail -1 | awk '{print \$2}'"
+						cli_pkg_version="$($sh_c "$search_command" | cut -d':' -f 2)"
+					fi
+					# Cut out the epoch and prefix with a '-'
+					pkg_version="-$(echo "$pkg_version" | cut -d':' -f 2)"
+				fi
+			fi
+			(
+				pkgs="docker-ce$pkg_version"
+				if version_gte "18.09"; then
+					# older versions didn't ship the cli and containerd as separate packages
+					if [ -n "$cli_pkg_version" ]; then
+						pkgs="$pkgs docker-ce-cli-$cli_pkg_version containerd.io"
+					else
+						pkgs="$pkgs docker-ce-cli containerd.io"
+					fi
+				fi
+				if version_gte "20.10"; then
+					pkgs="$pkgs docker-compose-plugin docker-ce-rootless-extras$pkg_version"
+				fi
+				if version_gte "23.0"; then
+						pkgs="$pkgs docker-buildx-plugin"
+				fi
+				if ! is_dry_run; then
+					set -x
+				fi
+				$sh_c "$pkg_manager install -y -q $pkgs"
+			)
+			echo_docker_as_nonroot
+			exit 0
+			;;
+		sles)
+			if [ "$(uname -m)" != "s390x" ]; then
+				echo "Packages for SLES are currently only available for s390x"
+				exit 1
+			fi
+			if [ "$dist_version" = "15.3" ]; then
+				sles_version="SLE_15_SP3"
+			else
+				sles_minor_version="${dist_version##*.}"
+				sles_version="15.$sles_minor_version"
+			fi
+			repo_file_url="$DOWNLOAD_URL/linux/$lsb_dist/$REPO_FILE"
+			pre_reqs="ca-certificates curl libseccomp2 awk"
+			(
+				if ! is_dry_run; then
+					set -x
+				fi
+				$sh_c "zypper install -y $pre_reqs"
+				$sh_c "zypper addrepo $repo_file_url"
+				if ! is_dry_run; then
+						cat >&2 <<-'EOF'
+						WARNING!!
+						openSUSE repository (https://download.opensuse.org/repositories/security:SELinux) will be enabled now.
+						Do you wish to continue?
+						You may press Ctrl+C now to abort this script.
+						EOF
+						( set -x; sleep 30 )
+				fi
+				opensuse_repo="https://download.opensuse.org/repositories/security:SELinux/$sles_version/security:SELinux.repo"
+				$sh_c "zypper addrepo $opensuse_repo"
+				$sh_c "zypper --gpg-auto-import-keys refresh"
+				$sh_c "zypper lr -d"
+			)
+			pkg_version=""
+			if [ -n "$VERSION" ]; then
+				if is_dry_run; then
+					echo "# WARNING: VERSION pinning is not supported in DRY_RUN"
+				else
+					pkg_pattern="$(echo "$VERSION" | sed 's/-ce-/\\\\.ce.*/g' | sed 's/-/.*/g')"
+					search_command="zypper search -s --match-exact 'docker-ce' | grep '$pkg_pattern' | tail -1 | awk '{print \$6}'"
+					pkg_version="$($sh_c "$search_command")"
+					echo "INFO: Searching repository for VERSION '$VERSION'"
+					echo "INFO: $search_command"
+					if [ -z "$pkg_version" ]; then
+						echo
+						echo "ERROR: '$VERSION' not found amongst zypper list results"
+						echo
+						exit 1
+					fi
+					search_command="zypper search -s --match-exact 'docker-ce-cli' | grep '$pkg_pattern' | tail -1 | awk '{print \$6}'"
+					# It's okay for cli_pkg_version to be blank, since older versions don't support a cli package
+					cli_pkg_version="$($sh_c "$search_command")"
+					pkg_version="-$pkg_version"
+				fi
+			fi
+			(
+				pkgs="docker-ce$pkg_version"
+				if version_gte "18.09"; then
+					if [ -n "$cli_pkg_version" ]; then
+						# older versions didn't ship the cli and containerd as separate packages
+						pkgs="$pkgs docker-ce-cli-$cli_pkg_version containerd.io"
+					else
+						pkgs="$pkgs docker-ce-cli containerd.io"
+					fi
+				fi
+				if version_gte "20.10"; then
+					pkgs="$pkgs docker-compose-plugin docker-ce-rootless-extras$pkg_version"
+				fi
+				if version_gte "23.0"; then
+						pkgs="$pkgs docker-buildx-plugin"
+				fi
+				if ! is_dry_run; then
+					set -x
+				fi
+				$sh_c "zypper -q install -y $pkgs"
+			)
+			echo_docker_as_nonroot
+			exit 0
+			;;
+		*)
+			if [ -z "$lsb_dist" ]; then
+				if is_darwin; then
+					echo
+					echo "ERROR: Unsupported operating system 'macOS'"
+					echo "Please get Docker Desktop from https://www.docker.com/products/docker-desktop"
+					echo
+					exit 1
+				fi
+			fi
+			echo
+			echo "ERROR: Unsupported distribution '$lsb_dist'"
+			echo
+			exit 1
+			;;
+	esac
+	exit 1
+}
+
+# wrapped up in a function so that we have some protection against only getting
+# half the file during "curl | sh"
+do_install