Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#46 update examples #49

Merged
merged 6 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

### Changed
* Updated examples & documentation
* Fixed domain init in DataInt
* Changed output options in Plot components.
* Fixed Windows install script trying to install from offline wheels.
Expand Down
24 changes: 12 additions & 12 deletions docs/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ DataBool
:height: 24
:width: 24

Defines a boolean variable.
Defines a boolean variable (`True` or `False`).


**Inputs**
Expand All @@ -34,7 +34,7 @@ DataCategorical
:height: 24
:width: 24

Defines a categorical variable.
Defines a categorical variable (for example, represening labels or classes).


**Inputs**
Expand Down Expand Up @@ -128,8 +128,8 @@ DatasetGenerator
:height: 24
:width: 24

Provides instructions on how to generate random samples for the dataset.

Provides instructions on how to generate random samples for the dataset by harnessing the parametric model found in the current Grasshopper file.
See Tutorial for more information on how to prepare the inputs and outputs of the parametric model.

**Outputs**

Expand Down Expand Up @@ -161,7 +161,7 @@ DatasetOneSample
:width: 24

Retrieves one sample from the dataset (at a given or random index) and instantiates it in the parametric model.

Requires a dataset to be loaded.

**Inputs**

Expand All @@ -180,7 +180,7 @@ DatasetSummary
:width: 24

Provides a summary of the dataset.

Requires a dataset to be loaded.

**Inputs**

Expand All @@ -198,7 +198,7 @@ Generator
:width: 24

Runs a generation campaing to create new designs using the trained model.

Requires a dataset and a trained model to be loaded.

**Inputs**

Expand All @@ -221,7 +221,7 @@ ModelDimensions
:width: 24

Retrieves dimensions of the model's input and output layers.

Requires that a model has been set up or loaded.

**Inputs**

Expand All @@ -239,7 +239,7 @@ ModelLoad
:width: 24

Loads an existing, pre-traind neural network model from a checkpoint.

Requires a dataset to be loaded.

**Inputs**

Expand All @@ -260,7 +260,7 @@ ModelSetup
:width: 24

Sets up an autoencoder model of the specified type with the given parameters.

Requires a dataset to be loaded.

**Inputs**

Expand All @@ -285,7 +285,7 @@ ModelSummary
:width: 24

Provides a summary of the autoencoder model's architecture.

Requires that a model has been set up or loaded.

**Inputs**

Expand All @@ -304,7 +304,7 @@ ModelTrain
:width: 24

Runs a training campaign.

Requires that a model has been set up (to train from scratch) or loaded (to continue training).

**Inputs**

Expand Down
Loading
Loading