-
Notifications
You must be signed in to change notification settings - Fork 4
1.1 Installation guide
This is the installation guide to set up the development environment.
The entire setup requires a lot of computing power to run the tools and OMA-ML at the same time in a developer setting. It is recommended to have at least a Quad-core (Physical cores) CPU and 16GB of RAM. Most components of OMA-ML can run on Windows 10/11, Mac OS, or Linux, but the frontend component is dependent on Visual Studio IDE which is currently only available for Windows or Mac OS.
- Visual Studio 2022 Community. Download link: https://visualstudio.microsoft.com/de/downloads/ When installing Visual Studio, the following "workload" packages are required:
- ASP.NET and web development
- Desktop development with C++ (installs C++ compiler for some Adapters)
The ASP.NET and web development package will install the localDB (MS SQL Database), which is required by the frontend component. In case the MS SQL Database does not install correctly using Windows 11 in combination with specific SSD types, manually install Microsoft SQL Server 2019 Express on another Hard drive. Download link: https://www.microsoft.com/de-de/download/details.aspx?id=101064
If you need to use the manually installed database, the connection string located here: frontend/src/Server/BlazorBoilerplate.Server/appsettings.json must be changed from:
- (localdb)\MSSQLLocalDB -> localhost\SQLEXPRESS In such cases be aware not to submit the appsettings.json when making commits.
- Visual Studio Code. Download link: https://code.visualstudio.com/Download
- Extensions: Python, Pylance, Docker, autoDocstring, vscode-proto3, Stardog RDF Grammars
The desktop versions are recommended, but the CLI-only version may also be used for docker and git:
- Docker Desktop. Download link: https://www.docker.com/products/docker-desktop/
- Github Desktop. Download link: https://desktop.github.com/
- Python, recommended version 3.9.X: Download link: https://www.python.org/downloads/
- Redis server. Download link: https://github.com/microsoftarchive/redis/releases
- MongoDB Community Server edition. Installation link: https://www.mongodb.com/try/download/community?tck=docs_server. During the installation wizard select Complete and Install MongoD as a Service when prompted. The rest can be left to default. The installer will also install MongoDBCompass, the client software to inspect MongoDB (Not required but nice to have).
Open GitHub Desktop and select Clone a repository from the Internet.... Within the new dialog select the URL tab, and insert the repository URL: https://github.com/hochschule-darmstadt/MetaAutoML.wiki.git. It is recommended to select a short local path to avoid any issues with long paths within Python (clone the repository on your desktop for example).
Currently unsupported adapters, only necessary if one develop the specific adapter.
When setting up AutoCVE, you must manually install NumPy before installing the requirements.txt. Do this by executing the command pip install numpy.
You need to download swig (https://swig.org/download.html) and set the PATH variable accordingly before installing the dependencies. (Info: currently auto Pytorch isn't supported by windows)
Important, a Python 3.8.x env is required.
On Windows, you must manually install SciPy: download scipy‑1.4.1‑cp35‑cp35m‑win_amd64.whl. Depending on the venv, you might need to rename the tags. Check compatible tags using: pip debug --verbose. And rename the file appropriately. Then execute it in the venv of AlphaD3M pip install scipy-1.4.1-py35-none-win_amd64.whl.
Using ubuntu, install sudo apt-get install python3.x-dev and python 3.8 and setup a venv in vscode and follow the dockfile installation.