Skip to content

Projects API#

Creation#

[source]

create_project#

Connection.create_project(name, description=None)

Create a new project.

Example for creating a new project

import hopsworks

connection = hopsworks.connection()

connection.create_project("my_hopsworks_project", description="An example Hopsworks project")
Arguments

  • name str: The name of the project.
  • arguments: optional description of the project

Returns

Project. A project handle object to perform operations on.


Retrieval#

[source]

get_project#

Connection.get_project(name=None)

Get an existing project.

Arguments

  • name str: The name of the project.

Returns

Project. A project handle object to perform operations on.


[source]

get_projects#

Connection.get_projects()

Get all projects.

Returns

List[Project]: List of Project objects


Properties#

[source]

created#

Timestamp when the project was created


[source]

description#

Description of the project


[source]

id#

Id of the project


[source]

name#

Name of the project


[source]

owner#

Owner of the project


Methods#

[source]

get_dataset_api#

Project.get_dataset_api()

Get the dataset api for the project.

Returns

DatasetApi: The Datasets Api handle


[source]

get_feature_store#

Project.get_feature_store()

Connect to Project's Feature Store API.

Returns

hsfs.feature_store.FeatureStore: The Feature Store API

Raises

  • RestAPIError: If unable to connect

[source]

get_git_api#

Project.get_git_api()

Get the git repository api for the project.

Returns

GitApi: The Git Api handle


[source]

get_jobs_api#

Project.get_jobs_api()

Get the jobs api for the project.

Returns

JobsApi: The Jobs Api handle


[source]

get_kafka_api#

Project.get_kafka_api()

Get the kafka api for the project.

Returns

KafkaApi: The Kafka Api handle


[source]

get_model_registry#

Project.get_model_registry()

Connect to Project's Model Registry API.

Returns

hsml.model_registry.ModelRegistry: The Model Registry API

Raises

  • RestAPIError: If unable to connect

[source]

get_model_serving#

Project.get_model_serving()

Connect to Project's Model Serving API.

Returns

hsml.model_serving.ModelServing: The Model Serving API

Raises

  • RestAPIError: If unable to connect

[source]

get_opensearch_api#

Project.get_opensearch_api()

Get the opensearch api for the project.

Returns

OpenSearchApi: The OpenSearch Api handle


[source]

get_url#

Project.get_url()