commit | 52c1e55dd54e13a7417c38f667d9c7c8835e09e9 | [log] [tgz] |
---|---|---|
author | cdmikechen <cdmikechen@apache.org> | Thu Sep 28 20:38:24 2023 +0800 |
committer | cdmikechen <cdmikechen@apache.org> | Fri Sep 29 07:59:44 2023 +0800 |
tree | 3cf27981126891183c7ccd248d8a6fde4e3084c5 | |
parent | 459fb987193d199d807831e534b1cc97e2ab159c [diff] |
SUBMARINE-1406. Fix misdescriptions in how-to-release documentation ### What is this PR for? Fix misdescriptions in how-to-release documentation ### What type of PR is it? Documentation ### Todos * [x] - ${git_tag} error * [x] - submarine-dist folder error * [x] - Add publish_release.sh command ### What is the Jira issue? https://issues.apache.org/jira/browse/SUBMARINE-1406 ### How should this be tested? NA ### Screenshots (if appropriate) NA ### Questions: * Do the license files need updating? No * Are there breaking changes for older versions? No * Does this need new documentation? No Author: cdmikechen <cdmikechen@apache.org> Signed-off-by: cdmikechen <cdmikechen@apache.org> Closes #1102 from cdmikechen/SUBMARINE-1406 and squashes the following commits: f29cb330 [cdmikechen] update pypi config 9685674f [cdmikechen] release document ce643fa7 [cdmikechen] Add python sdk change version c819874e [cdmikechen] Add more steps a70fc75a [cdmikechen] update release documents aa1c5453 [cdmikechen] add doap Submarine 952b2d2f [cdmikechen] Fix document
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.5.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
Login Submarine slack channel: https://join.slack.com/t/asf-submarine/shared_invite
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
From here, you can know the changelog and the issue tracker of different version of Apache Submarine.
Apache submarine: a unified machine learning platform made simple at EuroMLSys '22
The Apache Submarine project is licensed under the Apache 2.0 License. See the LICENSE file for details.