If you want to contribute to the development of MindsDB, you need to install from source.

If you do not want to contribute to the development of MindsDB but simply install and use it, then install MindsDB via Docker.

​
Install MindsDB for Development

Here are the steps to install MindsDB from source. You can either follow the steps below or visit the provided link.

Before installing MindsDB from source, ensure that you use one of the following Python versions: 3.9.x, 3.10.x, 3.11.x`.

  1. Fork the MindsDB repository from GitHub.

  2. Clone the fork locally:

    git clone https://github.com/<username>/mindsdb.git

  3. Create a virtual environment:

    python -m venv mindsdb-venv

  4. Activate the virtual environment:

    source mindsdb-venv/bin/activate

  5. Install MindsDB with its local development dependencies:

    Install dependencies:

    cd mindsdb
pip install -e .
pip install -r requirements/requirements-dev.txt

  6. Start MindsDB:

    python -m mindsdb

    By default, MindsDB starts the http and mysql APIs. You can define which APIs to start using the api flag as below.

    python -m mindsdb --api http,mysql,postgres,mongodb

    If you want to start MindsDB without the graphical user interface (GUI), use the --no_studio flag as below.

    python -m mindsdb --no_studio

Alternatively, you can use a makefile to install dependencies and start MindsDB:

 make install_mindsdb
 make run_mindsdb

Now you should see the following message in the console:

...

mindsdb.api.http.initialize:  - GUI available at http://127.0.0.1:47334/
mindsdb.api.mysql.mysql_proxy.mysql_proxy: Starting MindsDB Mysql proxy server on tcp://127.0.0.1:47335
mindsdb.api.mysql.mysql_proxy.mysql_proxy: Waiting for incoming connections...
mindsdb: mysql API: started on 47335
mindsdb: http API: started on 47334

You can access the MindsDB Editor at localhost:47334.

​
Install dependencies

The dependencies for many of the data or ML integrations are not installed by default.

If you want to use a data or AI/ML integration whose dependencies are not available by default, install it by running this command:

pip install .[handler_name]

You can find all available handlers here.

​
What’s Next?

Now that you installed and started MindsDB locally, go ahead and find out how to create and train a model using the CREATE MODEL statement.

Check out the Use Cases section to follow tutorials that cover Large Language Models, Chatbots, Time Series, Classification, and Regression models, Semantic Search, and more.

Was this page helpful?

Issue LabelsPython Coding Standards