Skip to main content

​
class Project

service_api: 'ServiceApi',
entity: 'str',
project: 'str',
attrs: 'Mapping[str, Any]'

​
Description

A project is a namespace for runs.

​
Args

  • service_api: The service API used to query W&B.
  • entity: The entity which owns the project.
  • project: The name of the project to query.
  • attrs: The attributes of the project.

​
Properties

​
property owner

Returns the project owner as a User object.

​
property path

Returns the path of the project. The path is a list containing the entity and project name.

​
property url

Returns the URL of the project.

​
property id

​
Methods

​
method artifacts_types

self,
per_page: 'int' = 50
Returns all artifact types associated with this project.
Arguments
  • per_page:

​
method collections

self,
filters: 'Mapping[str, Any] | None' = None,
order: 'str | None' = None,
per_page: 'int' = 50
Returns all artifact collections associated with this project.
Arguments
  • filters: Optional mapping of filters to apply to the query.
  • order: Optional string to specify the order of the results. If you prepend order with a + order is ascending (default). If you prepend order with a - order is descending.
  • per_page: The number of artifact collections to fetch per page. Default is 50.

​
method sweeps

self,
per_page: 'int' = 50
Return a paginated collection of sweeps in this project.
Arguments
  • per_page: The number of sweeps to fetch per request to the API.