KortexDL-python/kortexdl.py at main · Mostafasaad1/KortexDL-python · GitHub

1
2
3
4
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
"""
KortexDL - High-Performance Deep Learning Framework
====================================================

KortexDL is a deep learning framework built with Intel oneAPI MKL for
high-performance neural network computations.

Example usage:
    >>> import kortexdl as bd
    >>>
    >>> # Create a network
    >>> net = bd.Network([784, 256, 128, 10], bd.ActivationType.ReLU)
    >>>
    >>> # Train
    >>> loss = net.train_batch(inputs, targets, bd.LossType.MSE, 0.01, 32)
    >>>
    >>> # Predict
    >>> output = net.forward(input_data, 1, False)

For more information, see:
    - GitHub: https://github.com/Mostafasaad1/kortexdl-python
    - Examples: ./examples/
    - Notebooks: ./notebooks/
"""

__version__ = "2.0.0"
__author__ = "Mostafa Saad"

# Try to import the core C++ bindings
try:
    from _kortexdl_core import (
        # Core
        Network,
        Layer,

        # Enums
        ActivationType,
        LossType,
        ErrorCode,
        OptimizerType,
        RegularizationType,
        LRSchedulerType,

        # Config
        AccuracyConfig,
        TrainingMetrics,
        DataFrameConfig,

        # Data
        DataFrameLoader,
        Dataset,

        # Optimizers
        Optimizer,
        Adam,
        AdamW,
        SGD,
        Adagrad,
        Adadelta,
        RMSprop,
        Nadam,
        Adamax,
        Momentum,
        Nesterov,
        Lion,
        Ftrl,

        # Schedulers
        LRScheduler,
        ReduceLROnPlateau,

        # CNN Layers
        Conv2d,
        MaxPool2d,
        BatchNorm2d,
        Dropout,

        # Regularizers
        Regularizer,

        # Utilities
        create_optimizer,
        create_scheduler,
        create_regularizer,
        create_dataloader,

        # Accuracy utilities
        compute_mse,
        compute_mae,
        compute_rmse,
        compute_r2_score,
        compute_mape,
        compute_accuracy,
        compute_correlation,

        # Memory utilities
        get_memory_info,
        get_memory_stats,
        check_memory_available,

        # Version
        getVersion,
    )

    BINDINGS_AVAILABLE = True

except ImportError as e:
    BINDINGS_AVAILABLE = False
    _import_error = str(e)

    def _raise_import_error(*args, **kwargs):
        raise ImportError(
            f"KortexDL C++ bindings not available: {_import_error}\n"
            "Build with: pip install -e . (requires Intel oneAPI)"
        )

    # Placeholder classes
    Network = _raise_import_error
    Layer = _raise_import_error
    ActivationType = None
    LossType = None

# Public API
__all__ = [
    # Version
    "__version__",
    "__author__",
    "BINDINGS_AVAILABLE",

    # Core
    "Network",
    "Layer",

    # Enums
    "ActivationType",
    "LossType",
    "ErrorCode",
    "OptimizerType",

    # Config
    "AccuracyConfig",
    "TrainingMetrics",

    # Data
    "DataFrameLoader",
    "Dataset",

    # Optimizers
    "Adam",
    "AdamW",
    "SGD",
    "Adagrad",
    "Adadelta",
    "RMSprop",
    "Nadam",
    "Adamax",
    "Momentum",
    "Lion",

    # CNN
    "Conv2d",
    "MaxPool2d",
    "BatchNorm2d",
    "Dropout",

    # Schedulers
    "LRScheduler",
    "ReduceLROnPlateau",

    # Utilities
    "compute_mse",
    "compute_mae",
    "compute_rmse",
    "compute_r2_score",
    "compute_accuracy",
]