commit | 3bf0bf1f5d28edea5a4a20d0a1ef7a94805ed2b1 | [log] [tgz] |
---|---|---|
author | brandonlin <brandonlin@verizonmedia.com> | Tue Jul 20 14:13:00 2021 +0800 |
committer | Kevin <pingsutw@apache.org> | Tue Jul 27 14:06:33 2021 +0000 |
tree | 841fc7cb4d90b29b71b838099c90e3a9a13d692b | |
parent | 6eb2eb115fcdcf33b3d088ac767321acc7714c51 [diff] |
SUBMARINE-943. add [tags] into experimentSpec and add a searchExperimentByTag function ### What is this PR for? We would like to allow users could define the tag on experiment by themself, and the tags should be also an useful field when they try to find experiment precisely, so I add a tags property into ExperimentSpec POJO and add a findExperimentByTag function. ### What type of PR is it? Improvement ### Todos add the new fields in front-end pages. ### What is the Jira issue? https://issues.apache.org/jira/browse/SUBMARINE-943 ### How should this be tested? The unit test has also been modified and added. ### Screenshots (if appropriate) N/A ### Questions: * Do the license files need updating? No * Are there breaking changes for older versions? No * Does this need new documentation? No Author: brandonlin <brandonlin@verizonmedia.com> Author: Brandon Lin <fatallin@gmail.com> Signed-off-by: Kevin <pingsutw@apache.org> Closes #685 from FatalLin/SUBMARINE-943 and squashes the following commits: e2e25116 [Brandon Lin] add comments 7c127265 [brandonlin] polish fdb95807 [brandonlin] polish 5136cb17 [brandonlin] polish a637a3dd [brandonlin] align code style 906fa4ef [brandonlin] fix matching logic 9cbe1468 [brandonlin] add [tags] into experimentSpec and add a searchExperimentByTag function
Apache Submarine (Submarine for short) is an End-to-End Machine Learning Platform to allow data scientists to create end-to-end machine learning workflows. On Submarine, data scientists can finish each stage in the ML model lifecycle, including data exploration, data pipeline creation, model training, serving, and monitoring.
Some open-source and commercial projects are trying to build an end-to-end ML platform. What's the vision of Submarine?
Theodore Levitt once said:
“People don’t want to buy a quarter-inch drill. They want a quarter-inch hole.”
experiment
on prem or cloud via easy-to-use UI/API/SDK.experiment
and dependencies of environment
.As mentioned above, Submarine attempts to provide Data-Scientist-friendly UI to make data scientists have a good user experience. Here're some examples.
# New a submarine client of the submarine server submarine_client = submarine.ExperimentClient(host='http://localhost:8080') # The experiment's environment, could be Docker image or Conda environment based environment = EnvironmentSpec(image='apache/submarine:tf-dist-mnist-test-1.0') # Specify the experiment's name, framework it's using, namespace it will run in, # the entry point. It can also accept environment variables. etc. # For PyTorch job, the framework should be 'Pytorch'. experiment_meta = ExperimentMeta(name='mnist-dist', namespace='default', framework='Tensorflow', cmd='python /var/tf_dist_mnist/dist_mnist.py --train_steps=100') # 1 PS task of 2 cpu, 1GB ps_spec = ExperimentTaskSpec(resources='cpu=2,memory=1024M', replicas=1) # 1 Worker task worker_spec = ExperimentTaskSpec(resources='cpu=2,memory=1024M', replicas=1) # Wrap up the meta, environment and task specs into an experiment. # For PyTorch job, the specs would be "Master" and "Worker". experiment_spec = ExperimentSpec(meta=experiment_meta, environment=environment, spec={'Ps':ps_spec, 'Worker': worker_spec}) # Submit the experiment to submarine server experiment = submarine_client.create_experiment(experiment_spec=experiment_spec) # Get the experiment ID id = experiment['experimentId']
submarine_client.get_experiment(id)
submarine_client.wait_for_finish(id)
submarine_client.get_log(id)
submarine_client.list_experiments(status='running')
For a quick-start, see Submarine On K8s
(Available on 0.6.0, see Roadmap)
If you want to know more about Submarine's architecture, components, requirements and design doc, they can be found on Architecture-and-requirement
Detailed design documentation, implementation notes can be found at: Implementation notes
Read the Apache Submarine Community Guide
How to contribute Contributing Guide
Issue Tracking: https://issues.apache.org/jira/projects/SUBMARINE
What to know more about what's coming for Submarine? Please check the roadmap out: https://cwiki.apache.org/confluence/display/SUBMARINE/Roadmap
The Apache Submarine project is licensed under the Apache 2.0 License. See the LICENSE file for details.