Workspace Classe

  • Riferimento

Rappresenta un'area di lavoro di Azure Quantum.

Quando si crea un oggetto Workspace, i chiamanti hanno due opzioni per identificare l'area di lavoro di Azure Quantum (in ordine di precedenza):

  1. specificare una posizione e un ID risorsa validi; o
  2. specificare un percorso, un ID sottoscrizione, un gruppo di risorse e un nome dell'area di lavoro validi.

È anche possibile usare una stringa di connessione per specificare i parametri di connessione a un'area di lavoro di Azure Quantum chiamando from_connection_string.

Se l'area di lavoro di Azure Quantum non dispone di archiviazione collegata, il chiamante deve anche passare una stringa di connessione valida dell'account di archiviazione di Azure.

Ereditarietà
builtins.object
Workspace

Costruttore

Workspace(subscription_id: str | None = None, resource_group: str | None = None, name: str | None = None, storage: str | None = None, resource_id: str | None = None, location: str | None = None, credential: object | None = None, user_agent: str | None = None, **kwargs: Any)

Parametri

Nome Descrizione
subscription_id

ID sottoscrizione di Azure. Ignorato se viene specificato resource_id.

Valore predefinito: None
resource_group

Nome del gruppo di risorse di Azure. Ignorato se viene specificato resource_id.

Valore predefinito: None
name

Nome dell'area di lavoro di Azure Quantum. Ignorato se viene specificato resource_id.

Valore predefinito: None
storage

Stringa di connessione dell'account di archiviazione di Azure. Obbligatorio solo se l'area di lavoro di Azure Quantum specificata non dispone di archiviazione collegata.

Valore predefinito: None
resource_id

ID risorsa dell'area di lavoro di Azure Quantum.

Valore predefinito: None
location

Area di Azure in cui viene effettuato il provisioning dell'area di lavoro di Azure Quantum. Può essere specificato come nome di area, ad esempio "Stati Uniti orientali" o come nome della località, ad esempio "eastus".

Valore predefinito: None
credential

Credenziali da usare per connettersi ai servizi di Azure. In genere uno dei tipi di credenziali di Azure.Identity.

L'impostazione predefinita è "DefaultAzureCredential", che tenterà più forme di autenticazione.

Valore predefinito: None
user_agent

Aggiungere il valore specificato come prefisso all'intestazione http User-Agent durante la comunicazione con il servizio Azure Quantum.

Valore predefinito: None

Metodi

append_user_agent

Aggiungere un nuovo valore all'agente utente dell'area di lavoro. I valori vengono accodati utilizzando un trattino.
cancel_job

Richiede all'area di lavoro di annullare l'esecuzione di un processo.
close_session

Chiude una sessione nell'area di lavoro specificata se la sessione non è in uno stato del terminale. In caso contrario, aggiorna solo i dettagli della sessione.
from_connection_string

Crea un nuovo client dell'area di lavoro di Azure Quantum da una stringa di connessione.
get_container_uri

Ottenere l'URI del contenitore in base all'ID processo o al nome del contenitore. Crea un nuovo contenitore se non esiste ancora.
get_job

Restituisce il processo corrispondente all'ID specificato.
get_quotas

Ottenere un elenco di quote per l'area di lavoro specificata. Ogni quota è rappresentata come dizionario, contenente le proprietà per tale quota.

Le proprietà quota comuni sono:

  • "dimension": dimensione a cui viene applicata la quota.
  • "scope": ambito a cui viene applicata la quota.
  • "provider_id": provider a cui viene applicata la quota.
  • "utilizzo": utilizzo corrente della quota.
  • "limit": limite della quota.
  • "period": periodo a cui viene applicata la quota.
get_session

Ottiene una sessione dall'area di lavoro.
get_targets

Restituisce tutte le destinazioni disponibili per questa area di lavoro filtrate in base al nome di destinazione e all'ID provider. Se viene passato il nome di destinazione, verrà restituito un singolo oggetto target . In caso contrario, restituisce un elenco di oggetti destinazione , filtrati facoltativamente in base all'ID provider.
list_jobs

Restituisce un elenco di processi che soddisfano i criteri di filtro facoltativi (limitati).
list_session_jobs

Ottiene tutti i processi associati a una sessione.
list_sessions

Ottenere l'elenco delle sessioni nell'area di lavoro specificata.
list_top_level_items

Ottenere un elenco di elementi di primo livello per l'area di lavoro specificata, che può essere processi autonomi (processi non associati a una sessione) o sessioni (che possono contenere processi).
open_session

Apre/crea una sessione nell'area di lavoro specificata.
refresh_session

Aggiorna i dettagli della sessione con le informazioni più recenti dell'area di lavoro.
submit_job

Invia un processo da elaborare nell'area di lavoro.

append_user_agent

Aggiungere un nuovo valore all'agente utente dell'area di lavoro. I valori vengono accodati utilizzando un trattino.

append_user_agent(value: str) -> None

Parametri

Nome Descrizione
value
Necessario

Valore UserAgent da aggiungere, ad esempio "azure-quantum-"

cancel_job

Richiede all'area di lavoro di annullare l'esecuzione di un processo.

cancel_job(job: Job) -> Job

Parametri

Nome Descrizione
job
Necessario

Processo da annullare.

Restituisce

Tipo Descrizione
Job

Processo di Azure Quantum che è stato richiesto di annullare, con stato aggiornato.

close_session

Chiude una sessione nell'area di lavoro specificata se la sessione non è in uno stato del terminale. In caso contrario, aggiorna solo i dettagli della sessione.

close_session(session: Session) -> None

Parametri

Nome Descrizione
session
Necessario

Sessione da chiudere.

from_connection_string

Crea un nuovo client dell'area di lavoro di Azure Quantum da una stringa di connessione.

from_connection_string(connection_string: str, **kwargs) -> Workspace

Parametri

Nome Descrizione
connection_string
Necessario

Stringa di connessione valida, in genere ottenuta dal pannello Quantum Workspace -> Operations -> Access Keys nel portale di Azure.

Restituisce

Tipo Descrizione
Workspace

Nuovo client dell'area di lavoro di Azure Quantum.

get_container_uri

Ottenere l'URI del contenitore in base all'ID processo o al nome del contenitore. Crea un nuovo contenitore se non esiste ancora.

get_container_uri(job_id: str | None = None, container_name: str | None = None, container_name_format: str | None = 'job-{job_id}') -> str

Parametri

Nome Descrizione
job_id

ID processo, il valore predefinito è Nessuno.

Valore predefinito: None
container_name

Nome contenitore, per impostazione predefinita Nessuno.

Valore predefinito: None
container_name_format

Per impostazione predefinita, il formato del nome del contenitore è "job-{job_id}".

Valore predefinito: job-{job_id}

Restituisce

Tipo Descrizione
str

URI contenitore.

get_job

Restituisce il processo corrispondente all'ID specificato.

get_job(job_id: str) -> Job

Parametri

Nome Descrizione
job_id
Necessario

ID di un processo da recuperare.

Restituisce

Tipo Descrizione
Job

Processo di Azure Quantum.

get_quotas

Ottenere un elenco di quote per l'area di lavoro specificata. Ogni quota è rappresentata come dizionario, contenente le proprietà per tale quota.

Le proprietà quota comuni sono:

  • "dimension": dimensione a cui viene applicata la quota.
  • "scope": ambito a cui viene applicata la quota.
  • "provider_id": provider a cui viene applicata la quota.
  • "utilizzo": utilizzo corrente della quota.
  • "limit": limite della quota.
  • "period": periodo a cui viene applicata la quota.
get_quotas() -> List[Dict[str, Any]]

Restituisce

Tipo Descrizione
List[Dict[str, Any]

Quote dell'area di lavoro.

get_session

Ottiene una sessione dall'area di lavoro.

get_session(session_id: str) -> Session

Parametri

Nome Descrizione
session_id
Necessario

ID della sessione da recuperare.

Restituisce

Tipo Descrizione
Session

Sessione di Azure Quantum

get_targets

Restituisce tutte le destinazioni disponibili per questa area di lavoro filtrate in base al nome di destinazione e all'ID provider. Se viene passato il nome di destinazione, verrà restituito un singolo oggetto target . In caso contrario, restituisce un elenco di oggetti destinazione , filtrati facoltativamente in base all'ID provider.

get_targets(name: str | None = None, provider_id: str | None = None) -> Target | Iterable[Target]

Parametri

Nome Descrizione
name

Il nome di destinazione facoltativo da filtrare per impostazione predefinita è Nessuna.

Valore predefinito: None
provider_id

L'ID provider facoltativo da filtrare per impostazione predefinita è Nessuna.

Valore predefinito: None

Restituisce

Tipo Descrizione
Union[Target, Iterable[Target]]

Una singola destinazione di Azure Quantum o un elenco iterabile/elenco di destinazioni.

list_jobs

Restituisce un elenco di processi che soddisfano i criteri di filtro facoltativi (limitati).

list_jobs(name_match: str | None = None, status: JobStatus | None = None, created_after: datetime | None = None) -> List[Job]

Parametri

Nome Descrizione
name_match

Espressione regolare facoltativa per la corrispondenza del nome del processo. Il valore predefinito è Nessuna.

Valore predefinito: None
status

Filtro facoltativo in base allo stato del processo. Il valore predefinito è Nessuna.

Valore predefinito: None
created_after

Filtro facoltativo in base ai processi creati dopo il tempo specificato. Il valore predefinito è Nessuna.

Valore predefinito: None

Restituisce

Tipo Descrizione
List[Job]

Processi che corrispondono ai criteri di ricerca.

list_session_jobs

Ottiene tutti i processi associati a una sessione.

list_session_jobs(session_id: str) -> List[Job]

Parametri

Nome Descrizione
session_id
Necessario

ID della sessione.

Restituisce

Tipo Descrizione
List[Job]

Elenco di tutti i processi associati a una sessione.

list_sessions

Ottenere l'elenco delle sessioni nell'area di lavoro specificata.

list_sessions() -> List[Session]

Restituisce

Tipo Descrizione
List[Session]

Elenco delle sessioni dell'area di lavoro.

list_top_level_items

Ottenere un elenco di elementi di primo livello per l'area di lavoro specificata, che può essere processi autonomi (processi non associati a una sessione) o sessioni (che possono contenere processi).

list_top_level_items() -> List[Job | Session]

Restituisce

Tipo Descrizione
List[Union[Job, Session]]

Elenco di processi o sessioni di livello superiore dell'area di lavoro.

open_session

Apre/crea una sessione nell'area di lavoro specificata.

open_session(session: Session) -> None

Parametri

Nome Descrizione
session
Necessario

Sessione da aprire/creare.

Restituisce

Tipo Descrizione
Session

Nuova sessione di Azure Quantum aperta.

refresh_session

Aggiorna i dettagli della sessione con le informazioni più recenti dell'area di lavoro.

refresh_session(session: Session) -> None

Parametri

Nome Descrizione
session
Necessario

Sessione da aggiornare.

submit_job

Invia un processo da elaborare nell'area di lavoro.

submit_job(job: Job) -> Job

Parametri

Nome Descrizione
job
Necessario

Processo da inviare.

Restituisce

Tipo Descrizione
Job

Processo di Azure Quantum inviato, con stato aggiornato.

Attributi

credential

Restituisce le credenziali usate per connettersi all'area di lavoro quantistica.

Restituisce

Tipo Descrizione
Any

Credenziali di Azure SDK da Azure.Identity.

location

Restituisce la posizione di Azure dell'area di lavoro Quantum.

Restituisce

Tipo Descrizione
str

Nome della posizione di Azure.

name

Restituisce il nome dell'area di lavoro quantistica.

Restituisce

Tipo Descrizione
str

Nome dell'area di lavoro di Azure Quantum.

resource_group

Restituisce il gruppo di risorse di Azure dell'area di lavoro quantistica.

Restituisce

Tipo Descrizione
str

Nome del gruppo di risorse di Azure.

storage

Restituisce il nome dell'account di archiviazione di Azure associato all'area di lavoro quantum.

Restituisce

Tipo Descrizione
str

Nome dell'account di archiviazione di Azure.

subscription_id

Restituisce l'ID sottoscrizione di Azure dell'area di lavoro Quantum.

Restituisce

Tipo Descrizione
str

ID sottoscrizione di Azure.

user_agent

Restituisce la stringa UserAgent dell'area di lavoro inviata al servizio tramite l'intestazione UserAgent.

Restituisce

Tipo Descrizione
str

Stringa agente utente.