arena

package module
v0.9.16 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 25, 2024 License: Apache-2.0 Imports: 5 Imported by: 9

README

Arena

CircleCI Build Status Go Report Card

View the Arena documentation.

Overview

Arena is a command-line interface for the data scientists to run and monitor the machine learning training jobs and check their results in an easy way. Currently it supports solo/distributed TensorFlow training. In the backend, it is based on Kubernetes, helm and Kubeflow. But the data scientists can have very little knowledge about kubernetes.

Meanwhile, the end users require GPU resource and node management. Arena also provides top command to check available GPU resources in the Kubernetes cluster.

In one word, Arena's goal is to make the data scientists feel like to work on a single machine but with the Power of GPU clusters indeed.

For the Chinese version, please refer to 中文文档

Setup

You can follow up the Installation guide

User Guide

Arena is a command-line interface to run and monitor the machine learning training jobs and check their results in an easy way. Please refer the User Guide to manage your training jobs.

Demo

Developing

Prerequisites:

  • Go >= 1.8
mkdir -p $(go env GOPATH)/src/github.com/kubeflow
cd $(go env GOPATH)/src/github.com/kubeflow
git clone https://github.com/kubeflow/arena.git
cd arena
make

arena binary is located in directory arena/bin. You may want to add the directory to $PATH.

Then you can follow Installation guide for developer

CPU Profiling

# set profile rate (HZ)
export PROFILE_RATE=1000

# arena {command} --pprof
arena list --pprof
INFO[0000] Dump cpu profile file into /tmp/cpu_profile

Then you can analyze the profile by following Go CPU profiling: pprof and speedscope

Adopters

If you are intrested in Arena and would like to share your experiences with others, you are warmly welcome to add your information on ADOPTERS.md page. We will continuousely discuss new requirements and feature design with you in advance.

FAQ

Please refer to FAQ

CLI Document

Please refer to arena.md

RoadMap

See RoadMap

Documentation

Overview

Copyright 2018 The Kubeflow Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChartsInfo added in v0.3.0

type ChartsInfo struct {
	ChartsVersion map[string]string
	ChartsHome    string
}

type Version

type Version struct {
	Version      string
	BuildDate    string
	GitCommit    string
	GitTag       string
	GitTreeState string
	GoVersion    string
	Compiler     string
	Platform     string
	ChartsInfo   ChartsInfo
}

Version contains Arena version information

func GetVersion

func GetVersion() Version

GetVersion returns the version information

func (Version) String

func (v Version) String() string

Directories

Path Synopsis
cmd
pkg
operators/et-operator/api/common
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.
operators/et-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/et-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/et-operator/client/clientset/versioned/typed/et/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/kubedl-operator/apis/apps/v1alpha1
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +kubebuilder:object:generate=true +groupName=apps.kubedl.io
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +kubebuilder:object:generate=true +groupName=apps.kubedl.io
operators/kubedl-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/kubedl-operator/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
operators/kubedl-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/kubedl-operator/client/clientset/versioned/typed/apps/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/kubedl-operator/client/clientset/versioned/typed/apps/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
operators/mpi-operator/apis/kubeflow/v1alpha1
+k8s:deepcopy-gen=package +groupName=kubeflow.org
+k8s:deepcopy-gen=package +groupName=kubeflow.org
operators/mpi-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/mpi-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/mpi-operator/client/clientset/versioned/typed/kubeflow/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/mpi-operator/client/clientset/versioned/typed/kubeflow/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
operators/pytorch-operator/apis/pytorch/v1
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.
operators/pytorch-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/pytorch-operator/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
operators/pytorch-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/pytorch-operator/client/clientset/versioned/typed/pytorch/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/pytorch-operator/client/clientset/versioned/typed/pytorch/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
operators/spark-operator/apis/sparkoperator.k8s.io/v1beta1
Package v1beta1 is the v1beta1 version of the API.
Package v1beta1 is the v1beta1 version of the API.
operators/spark-operator/apis/sparkoperator.k8s.io/v1beta2
Package v1beta2 is the v1beta2 version of the API.
Package v1beta2 is the v1beta2 version of the API.
operators/spark-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/spark-operator/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
operators/spark-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/spark-operator/client/clientset/versioned/typed/sparkoperator.k8s.io/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
Package fake has the automatically generated clients.
operators/spark-operator/client/clientset/versioned/typed/sparkoperator.k8s.io/v1beta2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
Package fake has the automatically generated clients.
operators/tf-operator/apis/common/v1
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.
operators/tf-operator/apis/common/v1beta2
Package v1beta2 is the v1beta2 version of the API.
Package v1beta2 is the v1beta2 version of the API.
operators/tf-operator/apis/tensorflow/v1
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.
operators/tf-operator/apis/tensorflow/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.
operators/tf-operator/apis/tensorflow/v1alpha2
Package v1alpha2 is the v1alpha2 version of the API.
Package v1alpha2 is the v1alpha2 version of the API.
operators/tf-operator/apis/tensorflow/v1beta2
Package v1beta2 is the v1beta2 version of the API.
Package v1beta2 is the v1beta2 version of the API.
operators/tf-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/tf-operator/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
operators/tf-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/tf-operator/client/clientset/versioned/typed/kubeflow/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/tf-operator/client/clientset/versioned/typed/kubeflow/v1alpha2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/tf-operator/client/clientset/versioned/typed/tensorflow/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/tf-operator/client/clientset/versioned/typed/tensorflow/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
operators/tf-operator/client/clientset/versioned/typed/tensorflow/v1beta2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/tf-operator/client/clientset/versioned/typed/tensorflow/v1beta2/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
operators/tf-operator/util
Package util provides various helper routines.
Package util provides various helper routines.
+k8s:deepcopy-gen=package
operators/volcano-operator/client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
operators/volcano-operator/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
operators/volcano-operator/client/clientset/versioned/typed/batch/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
operators/volcano-operator/client/clientset/versioned/typed/batch/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
samples

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL