project

Documentation

Index

• Constants
• Variables
• func AskForNewProject(projectDetails *AddProjectDetails, existingProjectNames []string) error
• func BuildProjectContext(ctx context.Context, projectEntity *ProjectEntity, schemaVersion int) (*hub.ProjectContext, error)
• func CopyProject(sourceCtx context.Context, sourceProject *ProjectEntity, ...) error
• func DeleteProject(ctx context.Context, project *ProjectEntity) error
• func DownloadProject(ctx context.Context, projectId string) (*http.Response, error)
• func ExportProject(ctx context.Context, projectId string, copyToUrl string, ...) (*tensorleapapi.Job, error)
• func ExportProjectIntoFile(ctx context.Context, project *ProjectEntity, outputDir string) error
• func ImportProject(ctx context.Context, projectName, importUrl string, meta *hub.ProjectMeta) error
• func ImportProjectFromFile(ctx context.Context, filePath, projectName string) error
• func ValidateProjectName(projectName, defaultProjectName string, projects []ProjectEntity) (string, error)
• type AddProjectDetails
• type ExportProjectParams
• type ProjectEntity
  • func AddProject(ctx context.Context, projectDetails *AddProjectDetails) (*ProjectEntity, error)
  • func AskAndAddProject(ctx context.Context, projectDetails *AddProjectDetails, ...) (*ProjectEntity, error)
  • func GetProjectFromFlag(ctx context.Context, projectIdFlag string, askForNewProjectFirst bool) (project *ProjectEntity, wasCreated bool, err error)
  • func GetProjects(ctx context.Context) ([]ProjectEntity, error)
  • func SelectOrCreateProject(ctx context.Context, projects []ProjectEntity, askForNewProjectFirst bool) (*ProjectEntity, bool, error)
  • func SelectProjectsToPublish(ctx context.Context, projectNamesFromArgs []string, allProjectFlag bool) ([]ProjectEntity, error)

Constants

const PUBLISH_TIMEOUT = 4 * time.Hour

Variables

var ProjectEntityDesc = entity.NewEntityDescriptor[ProjectEntity](
	"project",
	"projects",
	func(p *ProjectEntity) string { return p.GetName() },
	func(p *ProjectEntity) string { return p.GetCid() },
)

Functions

func AskForNewProject

func AskForNewProject(projectDetails *AddProjectDetails, existingProjectNames []string) error

func BuildProjectContext

func BuildProjectContext(ctx context.Context, projectEntity *ProjectEntity, schemaVersion int) (*hub.ProjectContext, error)

func CopyProject

func CopyProject(
	sourceCtx context.Context, sourceProject *ProjectEntity,
	targetCtx context.Context, targetProjectName string,
	exportOptions ExportProjectParams,
) error

func DeleteProject

func DeleteProject(ctx context.Context, project *ProjectEntity) error

func DownloadProject

func DownloadProject(ctx context.Context, projectId string) (*http.Response, error)

Not using apiClient because of the response type (file)

func ExportProject

func ExportProject(ctx context.Context, projectId string, copyToUrl string, options ExportProjectParams) (*tensorleapapi.Job, error)

func ExportProjectIntoFile

func ExportProjectIntoFile(ctx context.Context, project *ProjectEntity, outputDir string) error

func ImportProject

func ImportProject(ctx context.Context, projectName, importUrl string, meta *hub.ProjectMeta) error

func ImportProjectFromFile

func ImportProjectFromFile(ctx context.Context, filePath, projectName string) error

func ValidateProjectName

func ValidateProjectName(projectName, defaultProjectName string, projects []ProjectEntity) (string, error)

Types

type AddProjectDetails

type AddProjectDetails struct {
	Name        string
	Description string
}

type ExportProjectParams

type ExportProjectParams struct {
	NoCache                bool
	ExcludeCalculatedFiles bool
}

type ProjectEntity

type ProjectEntity = tensorleapapi.Project

func AddProject

func AddProject(ctx context.Context, projectDetails *AddProjectDetails) (*ProjectEntity, error)

func AskAndAddProject

func AskAndAddProject(ctx context.Context, projectDetails *AddProjectDetails, projects []ProjectEntity) (*ProjectEntity, error)

func GetProjectFromFlag

func GetProjectFromFlag(ctx context.Context, projectIdFlag string, askForNewProjectFirst bool) (project *ProjectEntity, wasCreated bool, err error)

func GetProjects

func GetProjects(ctx context.Context) ([]ProjectEntity, error)

func SelectOrCreateProject

func SelectOrCreateProject(ctx context.Context, projects []ProjectEntity, askForNewProjectFirst bool) (*ProjectEntity, bool, error)

func SelectProjectsToPublish

func SelectProjectsToPublish(ctx context.Context, projectNamesFromArgs []string, allProjectFlag bool) ([]ProjectEntity, error)