Error modules (#36)

* Develop (#35)

* adding glue module to enable error handling (#27)

* added batching runner (#28)

* Kings college london integration (#30)

* adding build using binary downloads (#8)

* adding build using binary downloads

* sorting out the build.rs

* updating build.rs for surrealml package

* prepping version for release

* now has target tracking (#10)

* adding check in build.rs for docs.rs

* removing build.rs for main surrealml to ensure that libraries using the core do not need to do anything in their build.rs

* adding machine learning pipelines for bioengineering projects at Kings College London

* Remove integrated_training_runner/run_env/ from tracking

* adding machine learning pipelines for bioengineering projects at Kings College London

* Update FFmpeg data access module and README (#29)

* adding run_env to the gitignore

---------

Co-authored-by: Yang Li <oliverlee2018@163.com>

* bumping the version

* updating the README and module

* updating the surrealml-core deployment workflow

* updating the surrealml-core deployment workflow

* updating cargo

---------

Co-authored-by: Sam Hillman <116303632+SHillman836@users.noreply.github.com>
Co-authored-by: Yang Li <oliverlee2018@163.com>

* merging error modules into the core

* merging error modules into the core

* merging error modules into the core

---------

Co-authored-by: Sam Hillman <116303632+SHillman836@users.noreply.github.com>
Co-authored-by: Yang Li <oliverlee2018@163.com>

Cargo.toml

@@ -1,4 +1,4 @@
-workspace = { members = ["modules/glue"] }
+
 [package]
 name = "surrealml"
 version = "0.1.0"

modules/core/Cargo.toml

@@ -8,6 +8,11 @@ license-file = "LICENSE"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+axum-feature = ["axum"]
+actix-feature = ["actix-web"]
+default = []
+
 [dependencies]
 regex = "1.9.3"
 ort = { version = "1.16.2", features = ["load-dynamic"], default-features = false }
@@ -16,7 +21,10 @@ once_cell = "1.18.0"
 bytes = "1.5.0"
 futures-util = "0.3.28"
 futures-core = "0.3.28"
-glue = { git = "https://github.com/surrealdb/surrealml.git" }
+thiserror = "1.0.57"
+serde = { version = "1.0.197", features = ["derive"] }
+axum = { version = "0.7.4", optional = true }
+actix-web = { version = "4.5.1", optional = true }
 
 
 [dev-dependencies]

modules/core/README.md

@@ -9,13 +9,6 @@ This crate is just the Rust implementation of the Surml API. It is advised that
 
 If nothing is configured the crate will compile the ONNX runtime into the binary. This is the default behaviour. However, if you want to use an ONNX runtime that is installed on your system, you can set the environment variable `ONNXRUNTIME_LIB_PATH` before you compile the crate. This will make the crate use the ONNX runtime that is installed on your system.
 
-## Modules
-
-This crate uses other modules. However, the other modules would have to be published if we wanted to refernece them via path. To avoid this, we reference the modules via the github url. This means that if a module is to be updated, the updates of that module need to be
-pushed to the `main` branch of this repository before the core can reference the updates in that module. A good example of this would be our glue module as seen below:
-```toml
-glue = { git = "https://github.com/surrealdb/surrealml" }
-```
 This houses reusable errors that are used across all the crates in the Surml ecosystem, and these errors can construct HTTP responses for the Axum and Actix web frameworks.
 
 ## Nix Support

modules/core/src/execution/compute.rs

@@ -3,11 +3,10 @@ use crate::storage::surml_file::SurMlFile;
 use std::collections::HashMap;
 use ndarray::{ArrayD, CowArray};
 use ort::{SessionBuilder, Value, session::Input};
+
 use super::onnx_environment::ENVIRONMENT;
-use glue::{
-    safe_eject,
-    errors::error::{SurrealError, SurrealErrorStatus}
-};
+use crate::safe_eject;
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 
 /// A wrapper for the loaded machine learning model so we can perform computations on the loaded model.

modules/core/src/lib.rs

@@ -89,6 +89,7 @@
 //! ```
 pub mod storage;
 pub mod execution;
+pub mod errors;
 
 
 /// Returns the version of the ONNX runtime that is used.

modules/core/src/storage/header/keys.rs

@@ -1,9 +1,8 @@
 //! Defines the key bindings for input data.
 use std::collections::HashMap;
-use glue::{
-    errors::error::{SurrealError, SurrealErrorStatus}, 
-    safe_eject_internal
-};
+
+use crate::safe_eject_internal;
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 
 /// Defines the key bindings for input data.

modules/core/src/storage/header/mod.rs

@@ -17,13 +17,8 @@ use version::Version;
 use engine::Engine;
 use origin::Origin;
 use input_dims::InputDims;
-use glue::{
-    safe_eject,
-    errors::error::{
-        SurrealError,
-        SurrealErrorStatus
-    }
-};
+use crate::safe_eject;
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 
 /// The header of the model file.

modules/core/src/storage/header/normalisers/mod.rs

@@ -12,10 +12,8 @@ pub mod wrapper;
 use super::keys::KeyBindings;
 use utils::{extract_label, extract_two_numbers};
 use wrapper::NormaliserType;
-use glue::{
-    safe_eject_option,
-    errors::error::{SurrealError, SurrealErrorStatus}
-};
+use crate::safe_eject_option;
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 
 /// A map of normalisers so they can be accessed by column name and input index.

modules/core/src/storage/header/normalisers/utils.rs

@@ -1,10 +1,10 @@
 //! Utility functions for normalisers to reduce code duplication in areas that cannot be easily defined in a struct.
 use regex::{Regex, Captures};
-use glue::{
+use crate::{
     safe_eject_option,
     safe_eject_internal,
-    errors::error::{SurrealError, SurrealErrorStatus}
 };
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 
 /// Extracts the label from a normaliser string.

modules/core/src/storage/header/normalisers/wrapper.rs

@@ -5,10 +5,9 @@ use super::log_scale;
 use super::z_score;
 use super::utils::{extract_label, extract_two_numbers};
 use super::traits::Normaliser;
-use glue::{
-    safe_eject_option,
-    errors::error::{SurrealError, SurrealErrorStatus}
-};
+
+use crate::safe_eject_option;
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 
 /// A wrapper for all different types of normalisers.

modules/core/src/storage/header/origin.rs

@@ -1,5 +1,5 @@
 //! Defines the origin of the model in the file.
-use glue::errors::error::{SurrealError, SurrealErrorStatus};
+use crate::errors::error::{SurrealError, SurrealErrorStatus};
 
 use super::string_value::StringValue;
 

modules/core/src/storage/header/output.rs

@@ -1,6 +1,6 @@
 //! Defines the struct housing data around the outputs of the model.
 use super::normalisers::wrapper::NormaliserType;
-use glue::{
+use crate::{
     safe_eject_option,
     errors::error::{
         SurrealError,

modules/core/src/storage/header/version.rs

@@ -1,5 +1,5 @@
 //! Defines the process of managing the version of the `surml` file in the file.
-use glue::{
+use crate::{
     safe_eject_option,
     safe_eject,
     errors::error::{

modules/core/src/storage/stream_adapter.rs

@@ -7,7 +7,7 @@ use futures_core::stream::Stream;
 use futures_core::task::{Context, Poll};
 use std::pin::Pin;
 use std::error::Error;
-use glue::{
+use crate::{
     safe_eject,
     errors::error::{
         SurrealError,

modules/core/src/storage/surml_file.rs

@@ -2,10 +2,10 @@
 use std::fs::File;
 use std::io::{Read, Write};
 
-use crate::storage::header::Header;
-use glue::{
+use crate::{
     safe_eject_internal,
     safe_eject,
+    storage::header::Header,
     errors::error::{
         SurrealError,
         SurrealErrorStatus

src/python_apis/storage.rs

@@ -122,7 +122,7 @@ pub fn add_description(file_id: String, description: String) {
 pub fn add_version(file_id: String, version: String) {
     let mut python_state = PYTHON_STATE.lock().unwrap();
     let wrapped_file = python_state.get_mut(&file_id).unwrap();
-    wrapped_file.header.add_version(version);
+    let _ = wrapped_file.header.add_version(version);
 }
 
 
@@ -161,7 +161,7 @@ pub fn add_author(file_id: String, author: String) {
 pub fn add_origin(file_id: String, origin: String) {
     let mut python_state = PYTHON_STATE.lock().unwrap();
     let wrapped_file = python_state.get_mut(&file_id).unwrap();
-    wrapped_file.header.add_origin(origin);
+    let _ = wrapped_file.header.add_origin(origin);
 }
 
 
@@ -213,7 +213,7 @@ pub fn add_normaliser(file_id: String, column_name: String, normaliser_label: St
     let normaliser = NormaliserType::new(normaliser_label, one, two);
     let mut python_state = PYTHON_STATE.lock().unwrap();
     let file = python_state.get_mut(&file_id).unwrap();
-    file.header.normalisers.add_normaliser(normaliser, column_name, &file.header.keys);
+    let _ = file.header.normalisers.add_normaliser(normaliser, column_name, &file.header.keys);
 }