wriftai package

Submodules

• api module
  • API
    • API.request()
    • API.async_request()
• authenticated_user module
  • UpdateUserParams
    • UpdateUserParams.username
    • UpdateUserParams.name
    • UpdateUserParams.bio
    • UpdateUserParams.urls
    • UpdateUserParams.company
    • UpdateUserParams.location
  • AuthenticatedUser
    • AuthenticatedUser.get()
    • AuthenticatedUser.async_get()
    • AuthenticatedUser.models()
    • AuthenticatedUser.async_models()
    • AuthenticatedUser.update()
    • AuthenticatedUser.async_update()
• common_types module
  • JsonValue
  • Model
    • Model.id
    • Model.name
    • Model.created_at
    • Model.visibility
    • Model.description
    • Model.updated_at
    • Model.source_url
    • Model.license_url
    • Model.paper_url
    • Model.owner
    • Model.hardware
    • Model.predictions_count
    • Model.categories
  • ModelCategory
    • ModelCategory.name
    • ModelCategory.slug
  • ModelVersion
    • ModelVersion.number
    • ModelVersion.release_notes
    • ModelVersion.created_at
    • ModelVersion.container_image_digest
  • ModelVersionWithDetails
    • ModelVersionWithDetails.schemas
    • ModelVersionWithDetails.number
    • ModelVersionWithDetails.release_notes
    • ModelVersionWithDetails.created_at
    • ModelVersionWithDetails.container_image_digest
  • ModelVisibility
    • ModelVisibility.private
    • ModelVisibility.public
  • SchemaIO
    • SchemaIO.input
    • SchemaIO.output
  • Schemas
    • Schemas.prediction
  • SortDirection
    • SortDirection.ASC
    • SortDirection.DESC
  • StrEnum
  • User
    • User.id
    • User.username
    • User.avatar_url
  • UserWithDetails
    • UserWithDetails.name
    • UserWithDetails.bio
    • UserWithDetails.urls
    • UserWithDetails.location
    • UserWithDetails.company
    • UserWithDetails.created_at
    • UserWithDetails.updated_at
    • UserWithDetails.id
    • UserWithDetails.username
    • UserWithDetails.avatar_url
• hardware module
  • HardwareWithDetails
    • HardwareWithDetails.gpus
    • HardwareWithDetails.cpus
    • HardwareWithDetails.ram_per_gpu_gb
    • HardwareWithDetails.ram_gb
    • HardwareWithDetails.name
    • HardwareWithDetails.identifier
    • HardwareWithDetails.created_at
  • HardwareResource
    • HardwareResource.list()
    • HardwareResource.async_list()
• model_categories module
  • ModelCategoryWithDetails
    • ModelCategoryWithDetails.description
    • ModelCategoryWithDetails.name
    • ModelCategoryWithDetails.slug
  • ModelCategories
    • ModelCategories.list()
    • ModelCategories.async_list()
• model_versions module
  • CreateModelVersionParams
    • CreateModelVersionParams.release_notes
    • CreateModelVersionParams.schemas
    • CreateModelVersionParams.container_image_digest
  • ModelVersions
    • ModelVersions.get()
    • ModelVersions.async_get()
    • ModelVersions.list()
    • ModelVersions.async_list()
    • ModelVersions.delete()
    • ModelVersions.async_delete()
    • ModelVersions.create()
    • ModelVersions.async_create()
• models module
  • ModelWithDetails
    • ModelWithDetails.overview
    • ModelWithDetails.latest_version
    • ModelWithDetails.id
    • ModelWithDetails.name
    • ModelWithDetails.created_at
    • ModelWithDetails.visibility
    • ModelWithDetails.description
    • ModelWithDetails.updated_at
    • ModelWithDetails.source_url
    • ModelWithDetails.license_url
    • ModelWithDetails.paper_url
    • ModelWithDetails.owner
    • ModelWithDetails.hardware
    • ModelWithDetails.predictions_count
    • ModelWithDetails.categories
  • ModelsSortBy
    • ModelsSortBy.CREATED_AT
    • ModelsSortBy.PREDICTION_COUNT
  • ModelPaginationOptions
    • ModelPaginationOptions.sort_by
    • ModelPaginationOptions.sort_direction
    • ModelPaginationOptions.category_slugs
    • ModelPaginationOptions.cursor
    • ModelPaginationOptions.page_size
  • UpdateModelParams
    • UpdateModelParams.name
    • UpdateModelParams.description
    • UpdateModelParams.visibility
    • UpdateModelParams.hardware_identifier
    • UpdateModelParams.source_url
    • UpdateModelParams.license_url
    • UpdateModelParams.paper_url
    • UpdateModelParams.overview
    • UpdateModelParams.category_slugs
  • CreateModelParams
    • CreateModelParams.name
    • CreateModelParams.hardware_identifier
    • CreateModelParams.visibility
    • CreateModelParams.description
    • CreateModelParams.source_url
    • CreateModelParams.license_url
    • CreateModelParams.paper_url
    • CreateModelParams.overview
    • CreateModelParams.category_slugs
  • ModelsResource
    • ModelsResource.delete()
    • ModelsResource.async_delete()
    • ModelsResource.list()
    • ModelsResource.async_list()
    • ModelsResource.get()
    • ModelsResource.async_get()
    • ModelsResource.create()
    • ModelsResource.async_create()
    • ModelsResource.update()
    • ModelsResource.async_update()
    • ModelsResource.search()
    • ModelsResource.async_search()
• pagination module
  • PaginatedResponse
    • PaginatedResponse.items
    • PaginatedResponse.next_cursor
    • PaginatedResponse.previous_cursor
    • PaginatedResponse.next_url
    • PaginatedResponse.previous_url
• predictions module
  • ErrorSource
    • ErrorSource.internal
    • ErrorSource.external
  • Status
    • Status.pending
    • Status.started
    • Status.failed
    • Status.succeeded
  • TaskError
    • TaskError.source
    • TaskError.message
    • TaskError.detail
  • PredictionModel
    • PredictionModel.owner
    • PredictionModel.name
    • PredictionModel.version_number
  • Prediction
    • Prediction.url
    • Prediction.id
    • Prediction.created_at
    • Prediction.status
    • Prediction.updated_at
    • Prediction.setup_time
    • Prediction.execution_time
    • Prediction.model
  • PredictionWithIO
    • PredictionWithIO.input
    • PredictionWithIO.output
    • PredictionWithIO.logs
    • PredictionWithIO.setup_logs
    • PredictionWithIO.error
    • PredictionWithIO.url
    • PredictionWithIO.id
    • PredictionWithIO.created_at
    • PredictionWithIO.status
    • PredictionWithIO.updated_at
    • PredictionWithIO.setup_time
    • PredictionWithIO.execution_time
    • PredictionWithIO.model
  • Webhook
    • Webhook.url
    • Webhook.secret
  • CreatePredictionParams
    • CreatePredictionParams.input
    • CreatePredictionParams.webhook
    • CreatePredictionParams.validate_input
  • WaitOptions
    • WaitOptions.on_poll
  • AsyncWaitOptions
    • AsyncWaitOptions.on_poll
  • DEFAULT_WAIT_OPTIONS
  • DEFAULT_ASYNC_WAIT_OPTIONS
  • Predictions
    • Predictions.get()
    • Predictions.async_get()
    • Predictions.list()
    • Predictions.async_list()
    • Predictions.create()
    • Predictions.async_create()
    • Predictions.wait()
    • Predictions.async_wait()
• users module
  • UsersSortBy
    • UsersSortBy.CREATED_AT
  • UserPaginationOptions
    • UserPaginationOptions.sort_by
    • UserPaginationOptions.sort_direction
    • UserPaginationOptions.cursor
    • UserPaginationOptions.page_size
  • UsersResource
    • UsersResource.get()
    • UsersResource.async_get()
    • UsersResource.list()
    • UsersResource.async_list()
    • UsersResource.search()
    • UsersResource.async_search()

Module contents

Package initializer for WriftAI Python Client.

class Client(api_base_url=None, access_token=None, client_options=None)

Bases: object

Initializes a new instance of the Client class.

• Parameters:
  • api_base_url (Optional[str]) – The base URL for the API. If not provided, it falls back to the environment variable WRIFTAI_API_BASE_URL or the default api base url.
  • access_token (Optional[str]) – Bearer token for authorization. If not provided it falls back to the environment variable WRIFTAI_ACCESS_TOKEN.
  • client_options (Optional [ClientOptions ]) – Additional options such as custom headers and timeout. Timeout defaults to 10s on all operations if not specified.

class ClientOptions

Bases: TypedDict

Typed dictionary for specifying additional client options.

headers : dict[str, Any]

Optional HTTP headers to include in requests.

timeout : Timeout

Timeout configuration for requests.This should be an instance of httpx.Timeout.

transport : BaseTransport | None

Optional custom transport for managing HTTP behavior.

class PaginationOptions

Bases: TypedDict

Options for pagination.

cursor : NotRequired[str]

Cursor for pagination.

page_size : NotRequired[int]

Number of items per page.