AI-eXtended Design (AIXD)
Project description
AI-eXtended Design (AIXD)
Introduction
In the current repository we collect the code for the general methodology for AI-augmented generative design. This methodology allows to invert the standard paradigm of parametric modelling, where the designer needs to tweak and tune the input parameters, iteratively or through trial and error, for achieving some desired performance values.
Instead, this method allows to, by just specifying the requirements' values, obtain a range of designs that closely approximate those. Besides, the present methodology allows the user to explore the design space, understand how different parameters relate to each other, areas of feasible and unfeasible designs, etc.
Documentation
A detailed documentation of the aixd
library is provided here. The documentation includes detailed installation instructions, API references, a user guide, application examples and more.
Installation
Requirements:
- Python >= 3.9
Latest stable version
Install aixd
using pip
pip install aixd
Install aixd
using conda
:
conda install -c conda-forge aixd
Note: It is recommended to use virtual environments to manage the dependencies of your projects. If you are using
conda
, you can create a new environment with conda create -n myproject python=3.9
and then activate it with
conda activate myproject
before installing aixd
.
Latest unstable version
Install the latest version using pip
from the git repository:
pip install --upgrade git+https://gitlab.renkulab.io/ai-augmented-design/aixd.git
Development
If you are going to develop on this repository, perform an installation from source:
git clone https://gitlab.renkulab.io/ai-augmented-design/aixd.git
cd aixd
Then, install using conda, to install all the dependencies into a new environment called aixd
:
conda env create -f environment.yml
Or using pip:
pip install -e ".[examples, dev]"
Check the contribution guidelines for more details.
Folders and structure
The structure we follow on the current repo is as follows:
examples
: all example applications of theaixd
toolboxsrc
: for all source code. It can be structure following the next structuressrc/aixd
: source code ofaixd
toolbox
Known issues
- Plotly image export can cause a hang of the system. This is due to a bug in Kaleido (the library
used by Plotly for image export) reported in here. A workaround is to
downgrade Kaleido to version
0.1.0.post1
, which can be done by runningpip install kaleido==0.1.0.post1
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aixd-0.12.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e13f304b900c16400fa4b54007d2e546fefc1cf4adffd039a80f812b06232916 |
|
MD5 | 22914f72911c835f19f6d6186c4aca5d |
|
BLAKE2b-256 | 7a1ca4613b42fa1e565b7864ccc07ca9dfdb2c2af355672bb7e3ee7b00f09b6a |