3LC Enterprise Customer Managed Quickstart#

Welcome to the 3LC Enterprise Quickstart guide! This guide is intended for developers, data scientists, and system administrators who are looking to get started with 3LC Enterprise installed in their own systems, on prem or in cloud.

Requirements#

In order to install 3LC Enterprise Customer Managed, you should have been provided the following through an agreement with 3LC, Inc.

  • Credentials to access our private Python repository. These are in the form of a user-name and a password. From here on these are called USERNAME and PASSWORD respectively.

  • A license key, hereafter called LICENSE_KEY

See the system requirements for supported operating systems and Python versions for the 3LC components, as well as PyTorch related prerequisites.

Install 3LC Enterprise#

Make sure to exchange the credential placeholders (USERNAME and PASSWORD) in the snippet below before executing.

python -m pip install --index-url https://<USERNAME>:<PASSWORD>@pypi.3lc.ai/repositories/releases --extra-index-url https://pypi.org/simple tlc-enterprise

3LC Object Service and Dashboard Service#

The Object Service and Dashboard Service are key components of 3LC Enterprise, enabling communication between the 3LC Dashboard in a web browser and your ML notebooks. Both components need to be explicitly started from a terminal in order to use the system.

License Setup#

The Object Service requires a valid license in order to run. The license key can be specified using one of the following options:

Environment Variable: The environment variable TLC_LICENSE should be set to point to either a file containing the license key, or to the license key itself. E.g.

set TLC_LICENSE=<LICENSE_KEY>
export TLC_LICENSE=<LICENSE_KEY>

Default License File: If the environment variable isn’t set (or is invalid) 3LC will look in the following default location for license file:

  • Linux: $HOME/.config/3LC/3lc_license

  • MacOS: $HOME/Library/Application Support/3LC/3lc_license

  • Windows: %LOCALAPPDATA%\3LC\3LC\3lc_license

Start the 3LC Object Service#

The 3LC Object Service facilitates the sharing of samples and metrics between the different client components in 3LC, including your notebooks and the 3LC Dashboard. It needs to be explicitly started from the terminal in order to use 3LC. The Object Service can be terminated by pressing Q from the terminal window.

To start the service with a predefined example configuration, the --with-public-examples option can be supplied. It extends the configuration to include some illustrative example projects and data.

3lc service --with-public-examples
../../_images/service-terminal-managed.png

Often you want to run the 3LC Dashboard Service on the same machine as the Object Service. It is therefore convenient to let the Object Service also start the Dashboard Service. This can be done by adding the --dashboard command line argument.

3lc service --dashboard

Start the 3LC Dashboard Service#

If the Dashboard Service has not been started with the --dashboard option described above, then open a new terminal and start the Dashboard Service with:

3lc-dashboard
../../_images/dashboard-terminal.png

That command will output the URL to the Dashboard, which you should be able to connect to using a web browser.

The Dashboard Service is terminated by pressing Ctrl-C from the terminal window.

Launch the 3LC Dashboard#

Launch the 3LC Dashboard in a browser at the URL provided when running the Dashboard Service, as described above, to explore your data. See the system requirements for supported browsers.

Please check that hardware GPU acceleration is enabled for your browser to get an optimal experience when using the Dashboard.

Next Steps#

With the Object Service and Dashboard running, the next step is to integrate 3LC into your Python Notebooks to gather data and metrics for display in the 3LC Dashboard. For specific implementation examples with popular machine learning frameworks and computer vision workflows, refer to the Example Notebooks. For a comprehensive overview of the entire system, consult the User Guide.