Skip to content

Getting Started

Login

Log in to the client using the credentials provided to you.

login

  • Domain
    Cloud customers will leave the domain field blank when logging in.
    Private build customers will be provided a domain to use when logging in.
  • Login - Click to open the web login page of the specified domain, enter login credentials, and toggle back to the BOSS app to proceed.

login

  • Register - Click to submit your details and generate a new user.

Projects

Immediately after login, the Projects view is displayed. A project is a handy way to group artifacts based on data science problem.

projects

  • Available Projects – a list of all projects the logged in user has access to open.
  • Global Status – the status of all artifacts on the currently logged in system.
  • Federated Status – the number of online/offline artifacts of the given type.
  • Open Unallocated – begin using BOSS without an open project. Any artifacts created here will be saved as unallocated and still accessible from this button.
  • Search – search for a project by name or description.
  • Grid/List view – change how the set of projects is displayed.
  • Project – select this item to see more details about the project.
  • Federate list - a list of all federates available to the user.

Hovering over a project item will display the ‘Options’ menu.

projectoptions

  • Edit Details – change the name and description of the hovered project.
  • Change Cover – select a meaningful cover photo (optional).
  • Show Details – View project details on right side of screen.
  • Delete – Delete the project. Any artifacts allocated to that project will be moved to the ‘Unallocated’ space and can still be used.

Federation

From the Projects view, a user can access the Federation view.

federation

  • Federate list – a list of all accessible federates.
  • Zoom – Control the map zoom.
  • Filters - Show/Hide individual bars in bar chart.

Selecting a federate from the list will zoom the map to its location and bring up additional details.

federate

  • Bar chart - Bars are scaled by type across federates. For example, all Data Source bars are operating off of the same scale.

Upon login, a user will see some form of this menu bar at the top of the screen, depending on which view is currently open.

navigation

  • File
    • Settings – Click to edit various user and system settings
    • Log Out
    • Close Project
  • Tools
    • Query Builder – Go to the query building tool
    • Data Transform - Add operations to a saved query to shape the data
    • Modeling – Easily start a training run
    • Notebooks - Launch Jupyter Notebooks in a web browser
  • Views
    • Sources – View the sources visualization
    • Virtual Datasets – View a list of available virtual datasets for training
    • Assets – Click to View a list of available embedding for training
    • Models – View a list of available models for training
    • Minimize All – Hide any open dockable panels to see the main view. Click again to unhide.
  • Help
    • About BOSS
    • BOSS Manual - View documentation
    • Show Log – Click to view a list of status messages on the BOSS system
    • Submit Feedback - Easy way to submit a problem or feedback to our developers
  • Project name – The name of the currently open project
  • Federate – The currently connected domain
  • Username – The currently logged in user

Federated BOSS

federation

Release 6.5.0 introduces Federated Machine Learning to the BOSS platform. This capability introduces new features to the BOSS platform in order to support the development of federated models. Namely, if your BOSS platform is set up as part of a federation, many of the operations you perform within the BOSS client will automatically be federated. This includes:

  • Query: if your query matches data on multiple systems, you will get results from all of those systems.
  • EDA / search tree creation: saving your query into an eda tree will also create the eda tree on your other federates.
  • VDS: a vds created containing data from a federated query will in turn be created on all federates containing relevant data.
  • Model definition: model definitions uploaded via the client will also be created on other federates.
  • Training object: when training a federated model, a corresponding training object will be created on all participating federates.