#19 add auto-generated documentation, wip

gramaziokohler · May 1, 2024 · 0b79a61 · 0b79a61
1 parent 36e4787
commit 0b79a61
Show file tree

Hide file tree

Showing 28 changed files with 454 additions and 5 deletions.
diff --git a/docs/_images/icons/aixd_DataBool.png b/docs/_images/icons/aixd_DataBool.png
diff --git a/docs/_images/icons/aixd_DataCat.png b/docs/_images/icons/aixd_DataCat.png
diff --git a/docs/_images/icons/aixd_DataInt.png b/docs/_images/icons/aixd_DataInt.png
diff --git a/docs/_images/icons/aixd_DataObjectsNames.png b/docs/_images/icons/aixd_DataObjectsNames.png
diff --git a/docs/_images/icons/aixd_DataReal.png b/docs/_images/icons/aixd_DataReal.png
diff --git a/docs/_images/icons/aixd_DatasetCreate.png b/docs/_images/icons/aixd_DatasetCreate.png
diff --git a/docs/_images/icons/aixd_DatasetLoad.png b/docs/_images/icons/aixd_DatasetLoad.png
diff --git a/docs/_images/icons/aixd_DatasetOneSample.png b/docs/_images/icons/aixd_DatasetOneSample.png
diff --git a/docs/_images/icons/aixd_DatasetSummary.png b/docs/_images/icons/aixd_DatasetSummary.png
diff --git a/docs/_images/icons/aixd_GenSampleEval.png b/docs/_images/icons/aixd_GenSampleEval.png
diff --git a/docs/_images/icons/aixd_GenSelect.png b/docs/_images/icons/aixd_GenSelect.png
diff --git a/docs/_images/icons/aixd_Generator.png b/docs/_images/icons/aixd_Generator.png
diff --git a/docs/_images/icons/aixd_ModelDims.png b/docs/_images/icons/aixd_ModelDims.png
diff --git a/docs/_images/icons/aixd_ModelLoad.png b/docs/_images/icons/aixd_ModelLoad.png
diff --git a/docs/_images/icons/aixd_ModelSetup.png b/docs/_images/icons/aixd_ModelSetup.png
diff --git a/docs/_images/icons/aixd_ModelSummary.png b/docs/_images/icons/aixd_ModelSummary.png
diff --git a/docs/_images/icons/aixd_ModelTrain.png b/docs/_images/icons/aixd_ModelTrain.png
diff --git a/docs/_images/icons/aixd_PlotContours.png b/docs/_images/icons/aixd_PlotContours.png
diff --git a/docs/_images/icons/aixd_PlotCorrelations.png b/docs/_images/icons/aixd_PlotCorrelations.png
diff --git a/docs/_images/icons/aixd_PlotDistributions.png b/docs/_images/icons/aixd_PlotDistributions.png
diff --git a/docs/_images/icons/aixd_ProjectSetup.png b/docs/_images/icons/aixd_ProjectSetup.png
diff --git a/docs/_images/icons/aixd_Reset.png b/docs/_images/icons/aixd_Reset.png
diff --git a/docs/_images/icons/aixd_Server.png b/docs/_images/icons/aixd_Server.png
diff --git a/docs/_images/icons/aixd_ShowFolder.png b/docs/_images/icons/aixd_ShowFolder.png
diff --git a/docs/_images/icons/aixd_W&B.png b/docs/_images/icons/aixd_W&B.png
diff --git a/docs/documentation.rst b/docs/documentation.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,10 +1,12 @@
+.. _introduction:
+
 ********************************************************************************
-aixd_grasshopper
+ARA
 ********************************************************************************
 
-.. rst-class:: lead
+Grasshopper plugin for data-driven and inverse design methods with generative AI.
 
-Grasshopper plugin for the AIXD toolkit
+.. rst-class:: lead
 
 .. .. figure:: /_images/
      :figclass: figure
@@ -20,9 +22,9 @@ Table of Contents
 
    Introduction <self>
    installation
+   documentation
    tutorial
    examples
-   api
    license
 
 

diff --git a/src/aixd_grasshopper/components/aixd_ModelLoad/metadata.json b/src/aixd_grasshopper/components/aixd_ModelLoad/metadata.json
@@ -17,7 +17,7 @@
             },
             {
                 "name": "checkpoint_name",
-                "description": "Name of the checkpoint file to load the model from, without the file extension. The file's extension must be *.ckpt.",
+                "description": "Name of the checkpoint file to load the model from, without the file extension. The file's extension must be .ckpt",
                 "typeHintID": "str",
                 "scriptParamAccess": 0
             },