4.6.4 Install OML4Py Client Package

Instructions for installing OML4Py Client for Windows.

Steps to install the OML4Py client package on Windows

Download and Extract the OML4Py Client Installation File

To download and extract the OML4Py client installation file, do the following:

1. Download the client installation zip file.

   1. Go to the Oracle Machine Learning for Python Downloads page on the Oracle Technology Network.
   2. Accept the license agreement.
   3. Select Oracle Machine Learning for Python Client Install on Windows.
   4. Save the zip file to an accessible directory.

2. Navigate to the directory to which you downloaded the zip file and unzip the file.

   unzip oml4py_windows_client.zip

   The contents are extracted to a subdirectory named client, which contains these four files:

   • client/client.bat
   • client/libmmd.dll
   • client/oml-2.1-cp313-cp313-win_amd64.whl
   • client/sitecustomize.py

Install OML4Py client

OMl4Py client can be installed either by using the bat script or by without script.

1. Install OML4Py client with bat script

   1. Set all files under client folder to READ only.

      icacls "client\*" /inheritance:r 
      icacls "client\*" /remove:g Administrators SYSTEM %USERNAME% 
      icacls "client\*" /grant:r %USERNAME%:RX Administrators:RX SYSTEM:RX

   2. Install OML4Py:

      To install OML4Py run the following command:

      cd client 
      client.bat -i

   3. Uninstall OML4Py:

      To uninstall OML4P run the following command:

      client.bat -u

   Client installation script guidance

   -h, --help : -h or --help will show the usage of install bat script.

   client -h

   -i, --install: -i or --install will install the OML4Py client. --proxy will specify HTTP proxy for pip install.

   client.bat -i --proxy=www.example.com:<port>

   --dep-pkgs: It specifies the folder containing prebuilt dependent packages. Pip will install the missing dependent package from --dep-pkgs folder first.

   client -i --dep-pkgs C:\Users\<YourUsername>\Desktop\oml4py\client\supporting

   --target: --target will install client into specified target directory.

   client -i --target C:\Users\<YourUsername>\Desktop\oml4py\client\install_test

   -y: -y will make the script never prompt, will always agree the script to proceed.

   client -i -y --target C:\Users\<YourUsername>\Desktop\oml4py\client\install_test

   --no-deps: --no-deps will skip the dependent package checking and installation.

   client -i --no-deps

   -u or --uninstall: -u or --uninstall will uninstall the OML4Py client.

   client -u

   For example:

   • Install with `--proxy` option
     • client -i --proxy http://www.-proxy.example.com:80
     • client -i -y --proxy http://www.-proxy.example.com:80
     • client -i -–no-deps --proxy http://www.-proxy.example.com:80
   • Install with `--dep-pkgs` option
     • client -i --dep-pkgs C:\Users\<YourUsername>\Desktop\oml4py\client\supporting
     • client -i –y --dep-pkgs C:\Users\<YourUsername>\Desktop\oml4py\client\supporting
     • client -i -–no-deps --dep-pkgs C:\Users\<YourUsername>\Desktop\oml4py\client\supporting
   • Install with `--target` option
     • client -i --target C:\Users\<YourUsername>\Desktop\oml4py\client\install_test --proxy http://www.-proxy.example.com:80
     • client -i --target C:\Users\<YourUsername>\Desktop\oml4py\client\install_test --dep-pkgs C:\Users\<YourUsername>\Desktop\oml4py\client\supporting
   • Uninstall with `-y` option
     • client -u
     • client -u -y

2. To Install OML4Py client without script.

   You can directly install packages from a .whl file using pip3 if you don't want to verify dependencies, Python requirements, or set access control on the installation folder.

   1. Install oml whl from client folder:

      pip3 install --no-deps client/oml-2.1-cp313-cp313-win_amd64.whl

   2. Copy libmmd.dll to %PYTHONHOME%:

      cp client/libmmd.dll %PYTHONHOME%

   3. Copy sitecustomize.py to %PYTHONHOME%/Lib/site-packages/:

      cp client/sitecustomize.py %PYTHONHOME%/Lib/site-packages/