Skip to content

data

Dataset

A class to hold the data.

Attributes:

Name Type Description
x Float[ndarray, ' D']

The input x data (1D).
y Float[ndarray, ' D']

The input y data (1D).
n int

The number of data points.
Source code in gallifrey/data.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class Dataset:
    """
    A class to hold the data.

    Attributes
    ----------
    x : Float[jnp.ndarray, " D"]
        The input x data (1D).
    y : Float[jnp.ndarray, " D"]
        The input y data (1D).
    n : int
        The number of data points.

    """

    def __init__(
        self,
        x: Float[jnp.ndarray, " D"],
        y: Float[jnp.ndarray, " D"],
    ):
        """
        Initialize the Dataset instance.

        Parameters
        ----------
        x : Float[jnp.ndarray, " D"]
            The input x data.
        y : Float[jnp.ndarray, " D"]
            The input y data.
        """
        self.x = jnp.asarray(x)
        self.y = jnp.asarray(y)

        self._validate_input()

    @property
    def n(self) -> int:
        """
        Get the number of data points.

        Returns
        -------
        int
            The number of data points.
        """
        return self.x.shape[0]

    def _validate_input(self) -> None:
        """
        Check that the number of x and y values are the same.

        Raises
        ------
        ValueError
            If the number of x and y values are not the same.
        """

        if self.x.shape[0] != self.y.shape[0]:
            raise ValueError("The length of x and y must be the same.")

    def __repr__(self) -> str:
        """
        Return the string representation of the Dataset instance.

        Returns
        -------
        str
            The representation of the Dataset instance.
        """
        return f"Dataset(n={self.n},\n x={self.x},\n y={self.y})"

    def __str__(self) -> str:
        """
        Simplified string representation of the Dataset instance.

        Returns
        -------
        str
            The simplified string representation.
        """
        return f"Dataset(n={self.n})"

n property

Get the number of data points.

Returns:

Type Description
int

The number of data points.

__init__(x, y)

Initialize the Dataset instance.

Parameters:

Name Type Description Default
x Float[ndarray, ' D']

The input x data.

 required
y Float[ndarray, ' D']

The input y data.

 required
Source code in gallifrey/data.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def __init__(
    self,
    x: Float[jnp.ndarray, " D"],
    y: Float[jnp.ndarray, " D"],
):
    """
    Initialize the Dataset instance.

    Parameters
    ----------
    x : Float[jnp.ndarray, " D"]
        The input x data.
    y : Float[jnp.ndarray, " D"]
        The input y data.
    """
    self.x = jnp.asarray(x)
    self.y = jnp.asarray(y)

    self._validate_input()

__repr__()

Return the string representation of the Dataset instance.

Returns:

Type Description
str

The representation of the Dataset instance.
Source code in gallifrey/data.py 
65
66
67
68
69
70
71
72
73
74
def __repr__(self) -> str:
    """
    Return the string representation of the Dataset instance.

    Returns
    -------
    str
        The representation of the Dataset instance.
    """
    return f"Dataset(n={self.n},\n x={self.x},\n y={self.y})"

__str__()

Simplified string representation of the Dataset instance.

Returns:

Type Description
str

The simplified string representation.
Source code in gallifrey/data.py 
76
77
78
79
80
81
82
83
84
85
def __str__(self) -> str:
    """
    Simplified string representation of the Dataset instance.

    Returns
    -------
    str
        The simplified string representation.
    """
    return f"Dataset(n={self.n})"