data
ColumnDetails
Bases: TypedDict
Details about a column in a model schema.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the column. |
columnType |
ColumnType
|
The type of the column. |
dataType |
str
|
The data type of the column. |
className |
Optional[str]
|
Class name for prediction columns in a multiclass classification problem. |
Data
upload
classmethod
upload(df: pd.DataFrame) -> StorageInfo
Upload a pandas dataframe to NannyML Cloud
Returns:
| Name | Type | Description |
|---|---|---|
str |
StorageInfo
|
The ID of the uploaded dataset |
StorageInfo
Bases: TypedDict
Storage info for data.
NannyML Cloud accepts data from various sources. This type describes the different storage info types that can be used to specify the location of the data. Only one of the storage info types should be provided.
Attributes:
| Name | Type | Description |
|---|---|---|
raw |
Optional[StorageInfoRaw]
|
Storage info for |
azure |
Optional[StorageInfoAzureBlob]
|
Storage info for Azure Blob Storage. |
s3 |
Optional[StorageInfoS3]
|
Storage info for Amazon S3. |
cache |
Optional[StorageInfoCache]
|
Storage info for cached data. |
StorageInfoAzureBlob
Bases: TypedDict
Storage info for Azure Blob Storage.
Attributes:
| Name | Type | Description |
|---|---|---|
accountName |
str
|
The name of the storage account. |
container |
str
|
The name of the container. |
path |
str
|
The path to the data within the container. |
isPublic |
bool
|
Whether the data is publicly accessible. |
accountKey |
Optional[str]
|
The account key for the storage account. Should only be provided when using account key to authenticate. |
sasToken |
Optional[str]
|
The SAS (Shared Access Signature) token for the storage account. Should only be provided when using a SAS token to authenticate. |
StorageInfoCache
Bases: TypedDict
Storage info for cached data.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
str
|
The ID of the cached dataset. This ID is generated by the NannyML Cloud server when uploading data using Data.upload. |
StorageInfoRaw
Bases: TypedDict
Storage info for fsspec compatible input, e.g. public link.
Attributes:
| Name | Type | Description |
|---|---|---|
connectionString |
str
|
The connection string for the storage backend. |
options |
Dict[str, Any]
|
Additional options for the storage backend. |
StorageInfoS3
Bases: TypedDict
Storage info for Amazon S3.
Attributes:
| Name | Type | Description |
|---|---|---|
uri |
str
|
The S3 URI for the data, e.g. |
authenticationMode |
S3AuthenticationMode
|
The authentication mode to use. |
awsAccessKeyId |
Optional[str]
|
ID for the access key. Should only be provided when using access key to authenticate. |
awsSecretAccessKey |
Optional[str]
|
Secret for the access key. Should only be provided when using access key to authenticate. |