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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
use crate::app::event::Event;
use crate::app::state::{Consumed, SessionHelper, SessionState};
use crate::app::{AeonError, DynError};
use crate::debug;
use crate::inference::candidate_sampling::download_witnesses;
use crate::inference::inference_results::InferenceResults;
use crate::inference::inference_solver::FinishedInferenceSolver;
use crate::inference::inference_solver::InferenceSolver;
use crate::inference::inference_type::InferenceType;
use crate::inference::sampling_data::SamplingData;
use crate::sketchbook::data_structs::SketchData;
use crate::sketchbook::{JsonSerde, Sketch};
use std::sync::mpsc;
use std::sync::mpsc::{Receiver, Sender};
use std::sync::Arc;
use tauri::async_runtime::RwLock;
use super::inference_status::InferenceStatusReport;
use super::results_export::export_results;
/// InferenceState manages the main functionalities and computations of inference session.
/// That inludes boths the components that are exchanged with frontend,
/// and raw low-level structures used during computation like symbolic graph
/// and its colors.
pub struct InferenceState {
/// Boolean network sketch to run the inference on. Can be a placeholder at the beginning.
sketch: Sketch,
/// Flag signalling that the actual sketch data were received from editor session.
sketch_received: bool,
/// Potential inference solver instance.
solver: Option<Arc<RwLock<InferenceSolver>>>,
/// Potential channel to receive (text) updates from the solver instance.
receiver_channel: Option<Receiver<String>>,
/// Copy of already finished inference solver instance, used to work with full inference results.
/// If the inference ends with error, the error message is stored instead.
finished_solver: Option<Result<FinishedInferenceSolver, String>>,
/// Potential simplified processed results of the inference.
results: Option<InferenceResults>,
}
impl InferenceState {
/// Create new `InferenceState` with an empty placeholder sketch.
///
/// This is used to create a placeholder instance before the actual sketch data are sent from
/// the editor session.
pub fn new_empty() -> InferenceState {
InferenceState {
sketch: Sketch::default(),
sketch_received: false,
solver: None,
finished_solver: None,
results: None,
receiver_channel: None,
}
}
/// Create new `InferenceState` with a full sketch data.
pub fn new(sketch: Sketch) -> InferenceState {
InferenceState {
sketch,
sketch_received: true,
solver: None,
finished_solver: None,
results: None,
receiver_channel: None,
}
}
/// Update the sketch data of this `InferenceState`.
pub fn set_sketch(&mut self, sketch: Sketch) {
self.sketch = sketch;
self.sketch_received = true;
}
/// Get reference to the sketch data of this `InferenceState`.
pub fn get_sketch(&self) -> &Sketch {
&self.sketch
}
/// Getter for pre-processed results from the internal solver.
/// If the results were not fetched yet (inference still running), returns error.
///
/// This method is only a simple getter. See [Self::try_fetch_results] for actual result fetching.
pub fn get_results(&self) -> Result<InferenceResults, String> {
if let Some(Ok(solver)) = &self.finished_solver {
let results = solver.results.clone();
Ok(results)
} else if let Some(Err(e)) = &self.finished_solver {
Err(e.clone())
} else {
Err("Trying to get results that are not yet computed/fetched.".to_string())
}
}
}
/// More complex methods involving dealing with async solver.
impl InferenceState {
/// If a computation solver is running, send cancellation flag to it. This is done
/// asynchronously and might not happen immediately.
///
/// At the same time, all the inference-related fields of this `InferenceState` are reset.
/// That is solver and results. The sketch stays the same.
pub fn initiate_reset(&mut self) {
if let Some(solver) = &self.solver {
let solver: Arc<RwLock<InferenceSolver>> = Arc::clone(solver);
// there are two ways to cancel the computation
// 1) when we set the communiaction channel (receiver_channel) to None, the solver
// recognizes that and finishes
// 2) we spawn a thread to wait to achieve this "write lock" to the solver, and send it
// cancel flag directly
// this corresponds to method 2, which is now just a backup mechanism to 1
tokio::spawn(async move {
solver.write().await.cancel();
});
}
self.solver = None;
self.receiver_channel = None;
self.finished_solver = None;
self.results = None;
}
/// Check if the inference solver finished its computation. If so, clone the important parts
/// of the solver into `Self.finished_solver` field (so we can easily access it).
///
/// Return true if the fetch was successful (or results were already fetched before). Fetching
/// is unsuccessful if the computation is still running (or there is no computation).
///
/// Once the true is returned by this method, we know the computation is over, the results
/// are copied into `finished_solver` attribute and we can safely access them. If some
/// error happened during inference computation, the `finished_solver` field contains an Err.
pub fn try_fetch_results(&mut self) -> bool {
if self.finished_solver.is_some() {
debug!("Full results were already fetched. Not trying to fetch them again.");
return true;
}
if let Some(solver) = self.solver.clone() {
// computation is finished when we can obtain lock and `solver.is_finished()` is true
if let Ok(solver) = solver.try_read() {
if !solver.is_finished() {
// we got a lock, but computation is still running
return false;
}
self.finished_solver = Some(solver.to_finished_solver());
debug!(
"Successfully fetched results from solver (they still might contain error)."
);
true
} else {
// we cant get a lock, and computation is still running
false
}
} else {
// no computation running
false
}
}
/// Check if the results were already fetched from the solver.
pub fn check_if_results_fetched(&mut self) -> bool {
self.finished_solver.is_some()
}
/// Check if there are any new messages from the solver (reporting on its progress).
/// There can be more than one message. Each message is appended with a newline, and if there
/// is more than one, they are combined.
///
/// Return error if there is no new message, computation is finished, or it was not started yet.
pub fn try_get_solver_progress(&mut self) -> Result<Vec<InferenceStatusReport>, String> {
if self.finished_solver.is_some() {
return Err(
"Full results were already fetched. Not trying to fetch progress.".to_string(),
);
}
if let Some(receiver_channel) = self.receiver_channel.as_mut() {
let mut progress_updates = Vec::new();
while let Ok(json_status) = receiver_channel.try_recv() {
let progress_status = InferenceStatusReport::from_json_str(&json_status)?;
progress_updates.push(progress_status);
}
if progress_updates.is_empty() {
Err("No new message was sent.".to_string())
} else {
Ok(progress_updates)
}
} else {
Err("No computation is running.".to_string())
}
}
/// Start the inference computation on a separate thread. If some previous computation is
/// running, it is cancelled first.
///
/// The computation solver has its own thread. Method [Self::try_fetch_results] can be used to
/// test if the results are ready (and fetch them if so). Method [Self::try_get_solver_progress]
/// can be used to collect progress messages sent from the solver.
pub fn start_inference(&mut self, inference_type: InferenceType) -> Result<(), DynError> {
if !self.sketch_received || self.sketch.model.num_vars() == 0 {
return AeonError::throw("Cannot run inference on empty sketch.");
}
self.initiate_reset(); // Reset the state before starting new inference
let (progress_sender, progress_receiver): (Sender<String>, Receiver<String>) =
mpsc::channel();
self.receiver_channel = Some(progress_receiver);
let solver = Arc::new(RwLock::new(InferenceSolver::new(progress_sender)));
self.solver = Some(Arc::clone(&solver));
let sketch = self.sketch.clone();
// Capture only the necessary data for the async block
let solver_clone = Arc::clone(&solver);
// Spawn the async task for the inference
tokio::spawn(async move {
// this saves the results internally to the solver instance
let results =
InferenceSolver::run_inference_async(solver_clone, sketch, inference_type).await;
// this is just for debugging purposes
match results {
Ok(result) => debug!(
"Async inference thread finished. There are {} sat networks.",
result.num_sat_networks
),
Err(e) => debug!("Async inference thread finished with an error: {e}"),
}
});
Ok(())
}
}
impl SessionHelper for InferenceState {}
impl SessionState for InferenceState {
fn perform_event(&mut self, event: &Event, at_path: &[&str]) -> Result<Consumed, DynError> {
let component = "inference";
match at_path.first() {
Some(&"run_full_inference") => {
Self::assert_payload_empty(event, "inference")?;
debug!(
"Event `run_inference` received. Starting full inference with all properties."
);
self.start_inference(InferenceType::FullInference)?; // Start inference and handle asynchronously
let state_change = Event::build(&["inference", "inference_running"], Some("true"));
Ok(Consumed::Irreversible {
state_change,
reset: true,
})
}
Some(&"run_static_inference") => {
Self::assert_payload_empty(event, "inference")?;
debug!("Event `run_static_inference` received. Starting partial inference with static properties.");
self.start_inference(InferenceType::StaticInference)?; // Start inference and handle asynchronously
let state_change = Event::build(&["inference", "inference_running"], Some("true"));
Ok(Consumed::Irreversible {
state_change,
reset: true,
})
}
Some(&"run_dynamic_inference") => {
Self::assert_payload_empty(event, "inference")?;
debug!("Event `run_dynamic_inference` received. Starting partial inference with dynamic properties.");
self.start_inference(InferenceType::DynamicInference)?; // Start inference and handle asynchronously
let state_change = Event::build(&["inference", "inference_running"], Some("true"));
Ok(Consumed::Irreversible {
state_change,
reset: true,
})
}
Some(&"get_inference_results") => {
// Note that this event can be used to retrieve results of any running inference, be it
// full inference, static check, or dynamic check.
// The type of state change event is decided based on what kind of inference was running.
Self::assert_payload_empty(event, component)?;
//debug!("Event `get_inference_results` received. Trying to fetch inference results.");
// check if results were already fetched previously
let results_fetched = self.check_if_results_fetched();
// fetch results - but even if we manage to fetch them now, we will only access them next ping,
// so that we can first send all the remaining progress statuses before finishing the computation
self.try_fetch_results();
// there are four main scenarios:
// 1) the solver successfully finished and we extract full results and send them to FE
// 2) the solver finished with error and we send the error to FE
// 3) solver is still running, but it at least reported some progress and we send it to FE
// 4) there is no new progress, so we dont send anything
if results_fetched {
let state_change = match self.get_results() {
Ok(results) => {
let payload = results.to_json_str();
Event::build(&["inference", "inference_results"], Some(&payload))
}
Err(message) => {
let payload = serde_json::to_string(&message).unwrap();
Event::build(&["inference", "inference_error"], Some(&payload))
}
};
Ok(Consumed::Irreversible {
state_change,
reset: true,
})
} else if let Ok(progress_updates) = self.try_get_solver_progress() {
let payload = serde_json::to_string(&progress_updates).unwrap();
let state_change =
Event::build(&["inference", "computation_update"], Some(&payload));
Ok(Consumed::Irreversible {
state_change,
reset: true,
})
} else {
Ok(Consumed::NoChange)
}
}
Some(&"reset_inference") => {
Self::assert_payload_empty(event, component)?;
// this sends cancellation flag to the potentially running inference solver, and resets
// attributes of this InferenceState
self.initiate_reset();
let state_change = Event::build(&["inference", "inference_reset"], Some("true"));
Ok(Consumed::Irreversible {
state_change,
reset: true,
})
}
Some(&"sample_networks") => {
let payload = Self::clone_payload_str(event, component)?;
let sampling_data = SamplingData::from_json_str(&payload)?;
if let Some(Ok(solver)) = &self.finished_solver {
download_witnesses(
&sampling_data.path,
solver.sat_colors.clone(),
&solver.graph,
sampling_data.count,
sampling_data.seed,
)?;
Ok(Consumed::NoChange {})
} else {
AeonError::throw(
"Cannot sample networks because inference results were not fetched yet (or were erronous).",
)
}
}
Some(&"dump_full_results") => {
let archive_name = Self::clone_payload_str(event, component)?;
if let Some(Ok(solver)) = &self.finished_solver {
export_results(&archive_name, solver, &self.sketch)?;
Ok(Consumed::NoChange {})
} else {
AeonError::throw(
"Cannot dump inference results, they were not fetched yet (or were erronous).",
)
}
}
_ => Self::invalid_path_error_generic(at_path),
}
}
fn refresh(&self, full_path: &[String], at_path: &[&str]) -> Result<Event, DynError> {
let component_name = "inference";
// currently three options: get all datasets, a single dataset, a single observation
match at_path.first() {
Some(&"get_sketch") => {
Self::assert_path_length(at_path, 1, component_name)?;
let sketch_data = SketchData::new_from_sketch(&self.sketch);
Ok(Event {
path: full_path.to_vec(),
payload: Some(sketch_data.to_json_str()),
})
}
_ => Self::invalid_path_error_generic(at_path),
}
}
}
#[cfg(test)]
mod tests {
use crate::inference::inference_state::InferenceState;
use crate::inference::inference_type::InferenceType::*;
use crate::sketchbook::Sketch;
#[test]
/// Test basic manipulation with Inference state.
///
/// We only tests the basics, as the computation itself requires running async functions
/// which cant be tested easily. We use end-to-end tests for that.
fn test_inference_state_basics() {
let sketch = Sketch::default();
let mut inference_state = InferenceState::new(sketch.clone());
let sketch_copy = inference_state.get_sketch();
assert_eq!(&sketch, sketch_copy);
// check that there are no results at the start, and that we cant
assert!(inference_state.get_results().is_err());
// check that we cant get any progress or fetch results as there is no computation
assert_eq!(inference_state.try_fetch_results(), false);
assert!(inference_state.try_get_solver_progress().is_err());
// check that inference on empty sketch fails
let result = inference_state.start_inference(DynamicInference);
assert!(result.is_err());
// set new non-empty sketch data
let valid_sketch = Sketch::from_aeon("a -> a").unwrap();
inference_state.set_sketch(valid_sketch);
assert_eq!(inference_state.get_sketch().model.num_vars(), 1)
}
}