Projects API#
Creation#
create_project#
Connection.create_project(name, description=None, feature_store_topic=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")
- name
str: The name of the project. - description
str: optional description of the project - feature_store_topic
str: optional feature store topic name
Returns
Project. A project handle object to perform operations on.
Retrieval#
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.
get_projects#
Connection.get_projects()
Get all projects.
Returns
List[Project]: List of Project objects
Properties#
created#
Timestamp when the project was created
description#
Description of the project
id#
Id of the project
name#
Name of the project
owner#
Owner of the project
Methods#
get_dataset_api#
Project.get_dataset_api()
Get the dataset api for the project.
Returns
DatasetApi: The Datasets Api handle
get_environment_api#
Project.get_environment_api()
Get the Python environment AP
Returns
EnvironmentApi: The Python Environment Api handle
get_feature_store#
Project.get_feature_store(name=None)
Connect to Project's Feature Store.
Defaulting to the project name of default feature store. To get a shared feature store, the project name of the feature store is required.
Returns
hsfs.feature_store.FeatureStore: The Feature Store API
Raises
RestAPIError: If unable to connect
get_flink_cluster_api#
Project.get_flink_cluster_api()
Get the flink cluster api for the project.
Returns
FlinkClusterApi: The Flink Cluster Api handle
get_git_api#
Project.get_git_api()
Get the git repository api for the project.
Returns
GitApi: The Git Api handle
get_jobs_api#
Project.get_jobs_api()
Get the jobs api for the project.
Returns
JobsApi: The Jobs Api handle
get_kafka_api#
Project.get_kafka_api()
Get the kafka api for the project.
Returns
KafkaApi: The Kafka Api handle
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
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
get_opensearch_api#
Project.get_opensearch_api()
Get the opensearch api for the project.
Returns
OpenSearchApi: The OpenSearch Api handle
get_url#
Project.get_url()