Deployed 8ab5de6 with MkDocs version: 1.3.1

how-to-guides/install/index.html

@@ -400,6 +400,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#google-colab" class="md-nav__link">
+    Google Colab
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#command-line-tools" class="md-nav__link">
     Command-line tools
@@ -412,6 +419,13 @@
     Update
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#bleeding-edge" class="md-nav__link">
+    Bleeding edge
+  </a>
+  
 </li>
       
     </ul>
@@ -856,6 +870,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#google-colab" class="md-nav__link">
+    Google Colab
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#command-line-tools" class="md-nav__link">
     Command-line tools
@@ -868,6 +889,13 @@
     Update
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#bleeding-edge" class="md-nav__link">
+    Bleeding edge
+  </a>
+  
 </li>
       
     </ul>
@@ -900,6 +928,13 @@
 <p>Python 3.7 or later is required.</p>
 </blockquote>
 <p>This will work on all major operating systems.</p>
+<h2 id="google-colab">Google Colab<a class="headerlink" href="#google-colab" title="Permanent link">#</a></h2>
+<p>In order to use GreatAI in <a href="https://colab.research.google.com" target="_blank">Google Colab</a>, you need to downgrade <code>pyyaml</code> to a Colab compatible version. <a href="https://stackoverflow.com/questions/69564817/typeerror-load-missing-1-required-positional-argument-loader-in-google-col" target="_blank">See related StackOverflow question</a>.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>pip install great-ai <span class="nv">pyyaml</span><span class="o">==</span><span class="m">5</span>.4.1
+</code></pre></div>
+<blockquote>
+<p>This will make GreatAI work in Colab.</p>
+</blockquote>
 <h2 id="command-line-tools">Command-line tools<a class="headerlink" href="#command-line-tools" title="Permanent link">#</a></h2>
 <p>After installation, <code>great-ai</code> and <code>large-file</code> are available as commands. The former is required for deploying your application while the latter lets you manage models and datasets from your terminal.</p>
 <details class="note">
@@ -918,8 +953,15 @@
 </div>
 <h2 id="update">Update<a class="headerlink" href="#update" title="Permanent link">#</a></h2>
 <p>If you wish to update to the latest version execute:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>pip install --upgrade great-ai
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>pip install --upgrade great-ai
 </code></pre></div>
+<h2 id="bleeding-edge">Bleeding edge<a class="headerlink" href="#bleeding-edge" title="Permanent link">#</a></h2>
+<p>You can also install the latest (usually unreleased) version from GitHub.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>pip install --upgrade git+https://github.com/schmelczer/great-ai.git
+</code></pre></div>
+<blockquote>
+<p>Python 3.7 or later is required.</p>
+</blockquote>
 
   <hr>
 <div class="md-source-file">

how-to-guides/install/install.md

@@ -9,6 +9,15 @@ pip install great-ai
 
 This will work on all major operating systems.
 
+## Google Colab
+
+In order to use GreatAI in [Google Colab](https://colab.research.google.com){ target=_blank }, you need to downgrade `pyyaml` to a Colab compatible version. [See related StackOverflow question](https://stackoverflow.com/questions/69564817/typeerror-load-missing-1-required-positional-argument-loader-in-google-col){ target=_blank }.
+
+```sh
+pip install great-ai pyyaml==5.4.1
+```
+> This will make GreatAI work in Colab.
+
 ## Command-line tools
 
 After installation, `great-ai` and `large-file` are available as commands. The former is required for deploying your application while the latter lets you manage models and datasets from your terminal.
@@ -33,3 +42,12 @@ If you wish to update to the latest version execute:
 ```sh
 pip install --upgrade great-ai
 ```
+
+## Bleeding edge
+
+You can also install the latest (usually unreleased) version from GitHub.
+
+```sh
+pip install --upgrade git+https://github.com/schmelczer/great-ai.git
+```
+> Python 3.7 or later is required.