Impostazione delle librerie assetframe-lib e ibm-watson-studio-lib

La libreria 'assetframe-lib per Python è preinstallata e può essere importata direttamente in un notebook in watsonx.ai Studio. Tuttavia, si basa sulla libreria ibm-watson-studio-lib . La seguente procedura descrive come impostare entrambe le librerie.

Per inserire il token del progetto nel notebook:

1. Fare clic sull'icona Altro sulla barra degli strumenti del notebook, quindi fare clic su Inserisci token progetto.

   Se esiste un token del progetto, viene aggiunta una cella al notebook con le seguenti informazioni:

   from ibm_watson_studio_lib import access_project_or_space
   wslib = access_project_or_space({"token":"<ProjectToken>"})
   

   <ProjectToken> è il valore del token di progetto.

   Se viene indicato in un messaggio che non esiste alcun token di progetto, fare clic sul link nel messaggio da reindirizzare alla pagina Controllo accessi del progetto in cui è possibile creare un token di progetto. È necessario essere idonei per creare un token del progetto.

   Per creare un token di progetto:

   1. Dalla scheda Manage , selezionare la pagina Access Control e fare clic su New access token in Access tokens.
   2. Immettere un nome, selezionare il ruolo Editor per il progetto e creare un token.
   3. Tornare al blocco note, fare clic su Altro sulla barra degli strumenti del blocco note e fare clic su Inserisci token progetto.

2. Importare assetframe-lib e inizializzarlo con l'istanza ibm-watson-studio-lib creata.

   from assetframe_lib import AssetFrame
   AssetFrame._wslib = wslib
   

Funzioni e metodi assetframe - lib

La libreria assetframe - lib espone una serie di funzioni e metodi raggruppati nel seguente modo:

• Creazione di un frame di asset
• Creazione, richiamo e rimozione di feature
• Specifica degli attributi della funzione
  • Ruolo
  • Descrizione
  • Informazioni sulla correttezza per risultati favorevoli e sfavorevoli
  • Informazioni sulla correttezza per gruppi monitorati e di riferimento
  • Descrizioni dei valori
  • Istruzioni specifiche
  • Tag
• Anteprima dei dati
• Richiamo delle informazioni sulla correttezza

Creazione di un frame di asset

Un frame di asset viene utilizzato per definire i metadati del gruppo di funzioni su un asset di dati esistente o su un pandas DataFrame. È possibile avere esattamente un gruppo di funzioni per ogni asset. Se si crea una struttura di risorse su un panda DataFrame, è possibile memorizzare il panda DataFrame insieme ai metadati del gruppo di caratteristiche come risorsa di dati nel progetto.

È possibile utilizzare una delle seguenti funzioni per creare il frame di asset:

• AssetFrame.from_data_asset(asset_name, create_default_features=False)

  Questa funzione crea un nuovo frame di asset che racchiude un asset di dati esistente nel progetto. Se esiste già un gruppo di funzioni per questo asset, ad esempio creato nell'interfaccia utente, viene letto dai metadati dell'asset.

  Se la risorsa ha già delle descrizioni di colonna o dei tag di colonna definiti, ad esempio in IBM Knowledge Catalog, queste informazioni saranno automaticamente disponibili per le caratteristiche create.

  Parametri:

  • asset_name: (obbligatorio) il nome di un asset di dati nel progetto.
  • create_default_features: (Facoltativo) Crea funzioni per tutte le colonne nell'asset di dati.

• AssetFrame.from_pandas(name, dataframe, create_default_features=False)

  Questa funzione crea un nuovo frame di asset che racchiude un panda DataFrame.

  Parametri:

  • name: (Obbligatorio) Il nome del frame dell'asset. Questo nome verrà utilizzato come nome dell'asset di dati se si memorizza il gruppo di funzioni nel progetto in un passo successivo.

  • dataframe: (obbligatorio) un panda DataFrame che si desidera memorizzare insieme alle informazioni del gruppo di funzioni.

  • create_default_features: (Facoltativo) Crea funzioni per tutte le colonne nel frame di dati.

    Esempio di creazione di un asset frame da un pandas DataFrame:

    # Create an asset frame from a pandas DataFrame and set
    # the name of the asset frame.
    af = AssetFrame.from_pandas(dataframe=credit_risk_df, name="Credit Risk Training Data")
    

Creazione, richiamo e rimozione di funzioni

Una caratteristica definisce i metadati che possono essere utilizzati dai task di watsonx.ai Runtime a valle. È possibile creare una funzione per colonna nel dataset.

È possibile utilizzare una delle seguenti funzioni per creare, richiamare o rimuovere le colonne dal frame dell'asset:

• add_feature(column_name, role='Input')

  Questa funzione aggiunge una nuova funzione al frame dell'asset con il ruolo fornito.

  Parametri:

  • column_name: (Obbligatorio) Il nome della colonna per cui creare una funzione.

  • role: (Facoltativo) Il ruolo della funzione. Il valore predefinito è Input.
    

    I ruoli validi sono:
    

    • Input: l'input per un modello di machine learning
      
    • Destinazione: l'obiettivo di un modello di previsione
      
    • Identificativo: l'identificativo di una riga nel dataset.
      

• create_default_features()

  Questa funzione crea funzioni per tutte le colonne nel dataset. I ruoli delle funzioni verranno impostati per default su Input.

• get_features()

  Questa funzione richiama tutte le funzioni del frame di asset.

• get_feature(column_name)

  Questa funzione richiama la funzione per il nome colonna fornito.

  Parametri:

  • column_name: (Obbligatorio) Il nome stringa della colonna per cui creare la funzione.

• get_features_by_role(role)

  Questa funzione richiama tutte le funzioni del frame di dati con il ruolo specificato.

  Parametri:

  • role: (Obbligatorio) Il ruolo che le funzioni devono avere. Può essere Input, Destinazione o Identificativo.

• remove_feature(feature_or_column_name)

  Questa funzione rimuove l'elemento dal frame dell'asset.

  Parametri:

  • feature_or_column_name: (obbligatorio) una funzione o il nome della colonna per cui rimuovere la funzione.

Esempio che mostra la creazione di funzioni per tutte le colonne nel dataset e il richiamo di una di queste colonne per ulteriori specifiche:

# Create features for all columns in the data set and retrieve a column
# for further specifications.
af.create_default_features()
risk_feat = af.get_feature('Risk')

Specifica degli attributi della funzione

Le funzioni specificano metadati aggiuntivi sulle colonne che possono essere utilizzati nelle attività a valle di watsonx.ai Runtime.

È possibile utilizzare la seguente funzione per richiamare la colonna per cui è definita la funzione:

• get_column_name()

  Questa funzione richiama il nome della colonna per cui è definita la funzione.

# Set the role of the feature 'Risk' to 'Target' to use it as a target in a prediction model.
risk_feat = af.get_feature('Risk')
risk_feat.set_roles('Target')

# Set favorable and unfavorable labels for the target feature 'Risk'.
risk_feat = af.get_feature('Risk')
risk_feat.set_favorable_labels("No Risk")
risk_feat.set_unfavorable_labels("Risk")

# Set monitored and reference groups for the features 'Sex' and 'Age'.
sex_feat = af.get_feature("Sex")
sex_feat.set_reference_groups("male")
sex_feat.set_monitored_groups("female")

age_feat = af.get_feature("Age")
age_feat.set_monitored_groups("[0,25]")
age_feat.set_reference_groups("[26,80]")

plan_feat = af.get_feature("InstallmentPlans")
val_descriptions = [
    {'value': 'stores',
     'description': 'customer has additional business installment plan'},
    {'value': 'bank',
     'description': 'customer has additional personal installment plan'},
    {'value': 'none',
     'description': 'customer has no additional installment plan'}
]
plan_feat.set_value_descriptions(val_descriptions)

Anteprima dei dati

È possibile visualizzare l'anteprima dei dati dell'asset di dati o dei panda DataFrame con ulteriori informazioni sulle proprie funzioni, come le informazioni sulla correttezza.

I dati vengono visualizzati come un DataFrame di panda con informazioni facoltative sull'intestazione relative ai ruoli della funzione, alle descrizioni o alle ricette. Le informazioni sulla correttezza vengono visualizzate con la colorazione per le etichette favorevoli o sfavorevoli, monitorate e i gruppi di riferimento.

In questo momento, è possibile recuperare fino a 100 righe di dati campione per un asset di dati.

Utilizzare la seguente funzione per visualizzare l'anteprima dei dati:

• head(num_rows=5, display_options=['role'])

  Questa funzione restituisce le prime num_rows righe del data set in un panda DataFrame.

  Parametri:

  • num_rows : (facoltativo) il numero di righe da richiamare.

  • display_options: (Facoltativo) L'intestazione della colonna può visualizzare ulteriori informazioni per una colonna nel dataset.

    Utilizzare queste opzioni per visualizzare gli attributi della funzione:

    • role: visualizza il ruolo di una funzione per questa colonna.
    • description: visualizza la descrizione di una funzione per questa colonna.
    • recipe: visualizza la ricetta di una funzione per questa colonna.

Acquisizione delle informazioni sulla correttezza

È possibile richiamare le informazioni sulla correttezza di tutte le funzioni nel frame di asset come dizionario Python . Ciò include tutte le funzioni che contengono gruppi di riferimento o monitorati (o entrambi) come attributi protetti e la funzione di destinazione con etichette favorevoli o sfavorevoli.

Se il tipo di dati di una colonna con informazioni sulla correttezza è numerico, i valori delle etichette e dei gruppi vengono trasformati, se possibile, in valori numerici.

Le informazioni sulla correttezza possono essere utilizzate direttamente in AutoAI o AI Fairness 360.

È possibile utilizzare la seguente funzione per richiamare le informazioni sulla correttezza del frame di asset:

• get_fairness_info(target=None)

  Questa funzione restituisce un dizionario Python con etichette favorevoli e sfavorevoli della colonna di destinazione e attributi protetti con gruppi monitorati e di riferimento.

  Parametri:

  • target: (Facoltativo) La funzione di destinazione Se è presente una sola funzione con il ruolo Target, verrà utilizzata automaticamente.

    Esempio che mostra come richiamare le informazioni sulla correttezza:

    af.get_fairness_info()
    

    Output che mostra le informazioni di correttezza:

    {
    'favorable_labels': ['No Risk'],
    'unfavorable_labels': ['Risk'],
    'protected_attributes': [
        {'feature': 'Sex',
        'monitored_group': ['female'],
        'reference_group': ['male']},
        {'feature': 'Age',
        'monitored_group': [[0.0, 25]],
        'reference_group': [[26, 80]]
        }]
    }
    

Salvataggio delle informazioni sul gruppo di funzioni

Dopo aver specificato o aggiornato completamente le funzioni, è possibile salvare l'intera definizione del gruppo di funzioni come metadati per l'asset di dati.

Se si è creato l'asset frame da un pandas DataFrame,, verrà creato un nuovo asset di dati nell'archivio del progetto con il nome dell'asset frame.

È possibile utilizzare il metodo seguente per memorizzare le informazioni sul proprio gruppo di funzioni:

• to_data_asset(overwrite_data=False)

  Questo metodo salva le informazioni sul gruppo di funzioni nei metadati degli asset. Crea un nuovo asset di dati, se il frame dell'asset è stato creato da un pandas DataFrame.

  Parametri:

  • overwrite_data: (Facoltativo) Sovrascrivere anche il contenuto dell'asset con i dati dal frame dell'asset. Il valore predefinito è False.

Ulteriori informazioni

Consultare il progetto di esempio Creazione e utilizzo dei dati dell'archivio funzioni nell'hub risorse.

Argomento principale: Caricamento e accesso ai dati in un blocco note