MLExchange Content Registry

This is the first Dash 2 version of Content Registry.

Content registry and its API for the MLExchange platform. The architecture looks like below.

Contents include:
- models
- apps
- workflows
- assets (metadata, e.g., tags, trained models etc.) -

GUI

How to use

Prerequisite: install mlex_compute_api

Note: This version connects to a local mongodb container named mongodb with a port number 27017. Please checkout the atlas branch for using our cloud mongodb service.

Running content registry.

1. Create the same environmental file (.env) as the one used in the compute api.

   MONGO_DB_USERNAME=your_username     
   MONGO_DB_PASSWORD=your_password               
   

2. If it was the first time running MLExchange content registry, you need to initialize its database using the command ./init_db.sh. If the error msg says 'duplicate key error collection', it means the content database is already existent.

   Note: to re-initialize the database, it is suggested to first clean /dump folder in the local mongodb container.

3. Run docker-compose up --build.

Viewing existing contents
Scroll down to the bottom of the page, click on Refresh button.

Delete existing contents
Select contents from the table and click Delete button.

Modify existing contents
Currently, the Modify button is deprecated. Therefore, the easiest way to modify an existing registration is to delete the content, then either register a new content by filling out the forms or upload the revised JSON document again (drag and drop, click Validate button first, then click the Upload button).

Adaptive Dash GUI component

name: a unique string, equivalent to the id in each Dash component
param_key: a parameter key generally used to construct the cmd in job dictionary for MLExchange compute api

API calls

get_models()
get_model(uid)

get_apps()
get_app(uid)

get_workflows()
get_workflow(uid)

post_assets(data)
post_asset(data) get_assets()
get_asset(uid) delete_assets(query)
delete_asset(uid)

License

MLExchange Copyright (c) 2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

(3) Neither the name of the University of California, Lawrence Berkeley National Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.