> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# File

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    Source GitHub
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/files.py" />

## <kbd>class</kbd> `File`

Fichier enregistré dans W\&B.

Représente un fichier unique stocké dans W\&B. Donne accès aux métadonnées du fichier. Les fichiers sont associés à un run spécifique et peuvent inclure des fichiers texte, des poids de modèle, des jeux de données, des visualisations et d’autres Artifacts. Vous pouvez télécharger le fichier, le supprimer et accéder à ses propriétés.

Spécifiez un ou plusieurs attributs dans un dictionnaire pour identifier un fichier spécifique enregistré dans un run spécifique. Vous pouvez effectuer une recherche à l’aide des clés suivantes :

* id (str) : ID du run qui contient le fichier
* name (str) : nom du fichier
* url (str) : chemin vers le fichier
* direct\_url (str) : chemin vers le fichier dans le bucket
* sizeBytes (int) : taille du fichier en octets
* md5 (str) : md5 du fichier
* mimetype (str) : type MIME du fichier
* updated\_at (str) : horodatage de la dernière mise à jour
* path\_uri (str) : chemin vers le fichier dans le bucket, actuellement disponible uniquement pour les objets S3 et les fichiers de référence

**Arguments :**

* `service_api`:  L’instance de l’API de service à utiliser pour interroger W\&B.
* `attrs` (dict):  Un dictionnaire d’attributs qui définissent le fichier
* `run`:  L’objet run qui contient le fichier

### <kbd>propriété</kbd> File.path\_uri

Renvoie le chemin URI du fichier dans le bucket de stockage.

**Retourne :**

* `str` : L'URI S3 (par ex., 's3://bucket/path/to/file') si le fichier est stocké dans S3, l'URL directe s'il s'agit d'un fichier de référence, ou une chaîne vide s'il est indisponible.

**Retourne :**

* `str` : La valeur de propriété `path_uri`.

***

### <kbd>propriété</kbd> File.size

Renvoie la taille du fichier en octets.

**Retourne :**

* `int`: La valeur de la propriété size.

***

### <kbd>méthode</kbd> `File.delete`

```python theme={null}
delete() → None
```

Supprimez le fichier du serveur W\&B.

***

### <kbd>méthode</kbd> `File.download`

```python theme={null}
download(
    root: 'str' = '.',
    replace: 'bool' = False,
    exist_ok: 'bool' = False,
    api: 'Api | None' = None
) → io.TextIOWrapper
```

Télécharge un fichier précédemment enregistré par un run depuis le serveur wandb.

**Arguments :**

* `root` :  Répertoire local où enregistrer le fichier. La valeur par défaut est le répertoire de travail actuel (".").
* `replace` :  Si `True`, le téléchargement écrase un fichier local s'il existe. La valeur par défaut est `False`.
* `exist_ok` :  Si `True`, ne déclenche pas de `ValueError` si le fichier existe déjà et ne le retélécharge pas, sauf si `replace=True`. La valeur par défaut est `False`.
* `api` :  Si spécifié, l'instance `Api` utilisée pour télécharger le fichier.

**Exceptions levées :**
`ValueError` si le fichier existe déjà, `replace=False` et `exist_ok=False`.
