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

# Data Directory

> Python SDK reference for the DataDirectory class, including properties like storage root, FQN, and metadata.

## `module` `dataset.py`

***

## `class` `DataDirectory`

### `property` created\_at

Get the time at which DataDirectory was created

***

#### `property` created\_by

Get the information about who created the DataDirectory

***

#### `property` description

Get description of the DataDirectory

***

#### `property` fqn

Get fqn of the DataDirectory

***

#### `property` metadata

Get metadata for the current DataDirectory

***

#### `property` name

Get the name of the DataDirectory

***

#### `property` storage\_root

Get storage\_root of the DataDirectory

***

#### `property` updated\_at

Get the information about the when the DataDirectory was updated

***

### `function` `add_files`

Logs File in the `DataDirectory`.

**Args:**

* **`file_paths`** (List\[truefoundry.ml.DataDirectoryPath], optional): A list of pairs of (source path, destination path) to add files and folders to the DataDirectory contents. The first member of the pair should be a file or directory path and the second member should be the path inside the artifact contents to upload to.

```python lines theme={"dark"}
         E.g. >>> data_directory.add_files(
              ...     file_paths=[
                         truefoundry.ml.DataDirectoryPath("foo.txt", "foo/bar/foo.txt"),
                         truefoundry.ml.DataDirectoryPath("tokenizer/", "foo/tokenizer/"),
                         truefoundry.ml.DataDirectoryPath('bar.text'),
                         ('bar.txt', ),
                         ('foo.txt', 'a/foo.txt')
                      ]
              ... )
         would result in
         .
         └── foo/
             ├── bar/
             │   └── foo.txt
             └── tokenizer/
                 └── # contents of tokenizer/ directory will be uploaded here
```

**Examples:**

<CodeGroup>
  ```python Python lines theme={"dark"}
  import os
  from truefoundry.ml import get_client, DataDirectoryPath

  with open("artifact.txt", "w") as f:
       f.write("hello-world")

  client = get_client()
  data_directory = client.get_data_directory_by_fqn(fqn="<data_directory-fqn>")

  data_directory.add_files(
       file_paths=[DataDirectoryPath('artifact.txt', 'a/b/')]
  )
  ```
</CodeGroup>

***

### `function` `download`

Download an file or directory to a local directory if applicable, and return a local path for it.

**Args:**

* **`download_path`**: Relative source path to the desired files.
* **`path`**: Absolute path of the local filesystem destination directory to which to download the specified files. This directory must already exist. If unspecified, the files will either be downloaded to a new uniquely-named directory.
* **`overwrite`**: if to overwrite the files at/inside `dst_path` if they exist

**Returns:**

* **`str`**: Absolute path of the local filesystem location containing the desired files or folder.

**Examples:**

<CodeGroup>
  ```python Python lines theme={"dark"}
  from truefoundry.ml import get_client

  client = get_client()
  data_directory = client.get_data_directory_by_fqn(fqn="<your-artifact-fqn>")
  data_directory.download(download_path="<your-desired-download-path>")
  ```
</CodeGroup>

***

### `classmethod` `from_fqn`

Get the DataDirectory to download contents or load them in memory

**Args:**

* **`fqn`** (str): Fully qualified name of the data directory.

**Returns:**

* **`DataDirectory`**: An DataDirectory instance of the artifact

**Examples:**

<CodeGroup>
  ```python Python lines theme={"dark"}
  from truefoundry.ml import get_client, DataDirectory

  client = get_client()
  data_directory = DataDirectory.from_fqn(fqn="<data_directory-fqn>")
  ```
</CodeGroup>

***

### `function` `list_files`

List all the files and folders in the data\_directory.

**Args:**

* **`path`**: The path of directory in data\_directory, from which the files are to be listed.

**Returns:**

* **`str`**: Absolute path of the local filesystem location containing the desired files or folder.

**Examples:**

<CodeGroup>
  ```python Python lines theme={"dark"}
  from truefoundry.ml import get_client

  client = get_client()
  data_directory = client.get_data_directory_by_fqn(fqn="<your-artifact-fqn>")
  files = data_directory.list_files()
  for file in files:
       print(file.path)
  ```
</CodeGroup>

***

### `function` `update`

Updates the current instance of the DataDirectory.

**Examples:**

<CodeGroup>
  ```python Python lines theme={"dark"}
  from truefoundry.ml import get_client

  client = get_client()
  data_directory = client.get_data_directory_by_fqn(fqn="<your-data_directory-fqn>")
  data_directory.description = 'This is the new description'
  data_directory.update()
  ```
</CodeGroup>

***

## `class` `DataDirectoryPath`

DataDirectoryPath(src, dest)

***