Documentation

Access all resources and documentation or contact us for additional assistance.

Brainome PIP Installation

Brainome is easy to install with PIP on MacOS and Linux. It runs locally and keeps your data private.

It comes with a generous demo license for personal use and evaluation. For commercial use and/or larger data sets, please contact us at sales@brainome.ai.

Note: PIP installation on Windows 10 and macOS M1 is currently not supported and the Docker installation should instead be used.

Before you start

To install Braimone with PIP on your computer you need to have python3.7 or higher installed. If you are not sure how to check, follow the detailed instructions below.

Quick Installation

If you are familiar with Python and pip, all you need to do is to enter the following command depending on your operating system:

Generic

pip install brainome

Linux

python3 -m pip install brainome

macOS

python3 -m pip install brainome --user

This will proceed to download and install the packages required to run brainome.

Then run brainome with:

brainome
usage: brainome [-h] [-version] [-headerless] [-target TARGET] [-ignorecolumns IGNORECOLUMNS] [-rank [ATTRIBUTERANK]]
                [-measureonly] [-f FORCEMODEL] [-nosplit] [-split FORCESPLIT] [-nsamples NSAMPLES]
                [-ignoreclasses IGNORELABELS] [-usecolumns IMPORTANTCOLUMNS] [-o OUTPUT] [-v] [-q] [-y] [-e EFFORT]
                [-biasmeter] [-novalidation] [-balance] [-O OPTIMIZE] [-nofun]
                input [input …]
brainome: error: the following arguments are required: input

If you see the screen above, congratulations, Brainome is installed. Check out the Quickstart or the more comprehensive Tutorial to start doing machine learning!

If brainome is not in your path and is not found, see how to adjust your installation path here.

If you don’t see the screen above or you are not that familiar with Python and pip, please read on.

Detailed Instructions

Step 1: Check the python3 requirements

Brainome requires python3.7 or above to be installed. Check your python3 version as follow:

python3 --version
Python 3.8.5

If the version number is 3.7.x or above, you can jump to step 3
If the version number is 3.6.x or below or you get a “command not found” proceed to step 2.

 

Step 2: Install python3

Python3 is easily installed on your computer with the following step:

macOS

Click on the Install button and follow the instructions

Linux

sudo apt-get install python3

 For more detailed instructions on how to Install Python3, please refer to https://realpython.com/installing-python/

 

Step 3: Check the pip installer requirements

Pip is the python package installer. Check that it is installed on your machine as follow:

python3 -m pip –version
pip 20.0.2 from /usr/lib/python3/dist-packages/pip (python 3.8)

If you see the screen above (or similar), you can skip to step 5. 

 

Step 4: Install or upgrade pip

If the previous step returned “No module named pip”, you need to install pip on your machine.

macOS, Linux

python3 -m ensurepip --user

For more detailed instructions on how to installPIP, please refer to https://pip.pypa.io/en/stable/installing/

 

Step 5:  Install Brainome

Now that pip and Python3 are working, let’s install brainome:

python3 -m pip install brainome
Collecting brainome
  Using cached brainome-1.4.48-py3-none-any.whl
Collecting brainome-linux-python3.8==1.4.*
  Using cached brainome_linux_python3.8-1.4.162-py3-none-any.whl (2.7 MB)
Requirement already satisfied: xgboost in /usr/local/lib/python3.8/site-packages (from brainome-linux-python3.8==1.4.*->brainome) (1.4.0)
Requirement already satisfied: scikit-learn>=0.22.1 in /usr/local/lib/python3.8/site-packages (from brainome-linux-python3.8==1.4.*->brainome) (0.22.1)
Requirement already satisfied: requests in /usr/local/lib/python3.8/site-packages (from brainome-linux-python3.8==1.4.*->brainome) (2.25.1)
Requirement already satisfied: torch>=1.4.0 in /usr/local/lib/python3.8/site-packages (from brainome-linux-python3.8==1.4.*->brainome) (1.4.0)
Requirement already satisfied: numpy>=1.20.0 in /usr/local/lib/python3.8/site-packages (from brainome-linux-python3.8==1.4.*->brainome) (1.20.0)
Requirement already satisfied: Jinja2>=3.0.0 in ./.local/lib/python3.8/site-packages (from brainome-linux-python3.8==1.4.*->brainome) (3.0.1)
Requirement already satisfied: MarkupSafe>=2.0 in ./.local/lib/python3.8/site-packages (from Jinja2>=3.0.0->brainome-linux-python3.8==1.4.*->brainome) (2.0.1)
Requirement already satisfied: scipy>=0.17.0 in /usr/local/lib/python3.8/site-packages (from scikit-learn>=0.22.1->brainome-linux-python3.8==1.4.*->brainome) (1.6.1)
Requirement already satisfied: joblib>=0.11 in /usr/local/lib/python3.8/site-packages (from scikit-learn>=0.22.1->brainome-linux-python3.8==1.4.*->brainome) (1.0.1)
Requirement already satisfied: chardet<5,>=3.0.2 in /usr/local/lib/python3.8/site-packages (from requests->brainome-linux-python3.8==1.4.*->brainome) (3.0.4)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/local/lib/python3.8/site-packages (from requests->brainome-linux-python3.8==1.4.*->brainome) (1.22)
Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python3.8/site-packages (from requests->brainome-linux-python3.8==1.4.*->brainome) (2020.12.5)
Requirement already satisfied: idna<3,>=2.5 in /usr/local/lib/python3.8/site-packages (from requests->brainome-linux-python3.8==1.4.*->brainome) (2.6)
Installing collected packages: brainome-linux-python3.8, brainome
Successfully installed brainome-1.4.48 brainome-linux-python3.8-1.4.162

The last two lines tell us that brainome has been successfully installed. If you see those, go to step 6.

If you see something like the following screen, it means that PIP installation of brainome on your system is not supported:

python3 -m pip install brainome
Collecting brainome
  Using cached https://files.pythonhosted.org/packages/25/74/5421977f55bbc1e09849fae3762f8727f2d91f3e82cbf100894f50d2768a/brainome-1.4.48.tar.gz
Collecting brainome-linux-python3.6==1.4.* (from brainome)
Exception:
Traceback (most recent call last):
  File “/usr/lib/python3/dist-packages/pip/basecommand.py”, line 215, in main
    status = self.run(options, args)
  File “/usr/lib/python3/dist-packages/pip/commands/install.py”, line 353, in run
    wb.build(autobuilding=True)
  File “/usr/lib/python3/dist-packages/pip/wheel.py”, line 749, in build
    self.requirement_set.prepare_files(self.finder)
  File “/usr/lib/python3/dist-packages/pip/req/req_set.py”, line 380, in prepare_files
    ignore_dependencies=self.ignore_dependencies))
  File “/usr/lib/python3/dist-packages/pip/req/req_set.py”, line 554, in _prepare_file
    require_hashes
  File “/usr/lib/python3/dist-packages/pip/req/req_install.py”, line 278, in populate_link
    self.link = finder.find_requirement(self, upgrade)
  File “/usr/lib/python3/dist-packages/pip/index.py”, line 465, in find_requirement
    all_candidates = self.find_all_candidates(req.name)
  File “/usr/lib/python3/dist-packages/pip/index.py”, line 423, in find_all_candidates
    for page in self._get_pages(url_locations, project_name):
  File “/usr/lib/python3/dist-packages/pip/index.py”, line 568, in _get_pages
    page = self._get_page(location)
  File “/usr/lib/python3/dist-packages/pip/index.py”, line 683, in _get_page
    return HTMLPage.get_page(link, session=self.session)
  File “/usr/lib/python3/dist-packages/pip/index.py”, line 795, in get_page
    resp.raise_for_status()
  File “/usr/share/python-wheels/requests-2.18.4-py2.py3-none-any.whl/requests/models.py”, line 935, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 404 Client Error: Not Found for url: https://pypi.org/simple/brainome-linux-python3-6/

In case of a failed pip installation, we recommend using the Docker version of brainome. See also our tutorial on installing the Docker version.

 

Step 6: Verify the installation path

If your python3 installation is compliant, the brainome installation directory should already be in your path. Let’s check:

brainome -version
brainome v1.004-162-prod

Congratulations, brainome has been successfully installed. You are ready to build your first model!

However if you see the following error:

brainome -version
brainome: command not found

Your environment path needs to be updated. Depending on the shell you use, you will have to run the following command and optionally add it to your login script:

sh, bash, zsh

export PATH=$PATH:`python3 -m site --user-base`/bin

csh, tcsh

set path = ( $path `python3 -m site --user-base`/bin )