update workflows doc, todo p2p versioning

Author: erhant

Cargo.lock

@@ -7,15 +7,15 @@ endif
 ###############################################################################
 .PHONY: launch #       | Run with INFO logs in release mode
 launch:
-		RUST_LOG=none,dkn_compute=info,dkn_workflows=info cargo run --release
+		RUST_LOG=none,dkn_compute=info,dkn_workflows=info,dkn_p2p=info cargo run --release
 
 .PHONY: run #          | Run with INFO logs
 run:
-		RUST_LOG=none,dkn_compute=info,dkn_workflows=info cargo run
+		RUST_LOG=none,dkn_compute=info,dkn_workflows=info,dkn_p2p=info cargo run
 
 .PHONY: debug #        | Run with DEBUG logs with INFO log-level workflows
 debug:
-		RUST_LOG=warn,dkn_compute=debug,,dkn_workflows=debug,ollama_workflows=info cargo run
+		RUST_LOG=warn,dkn_compute=debug,dkn_workflows=debug,dkn_p2p=debug,ollama_workflows=info cargo run
 
 .PHONY: trace #        | Run with TRACE logs
 trace:

Makefile

@@ -1,13 +1,10 @@
 [package]
 name = "dkn-compute"
-version = "0.2.10"
+version = "0.2.11"
 edition.workspace = true
 license.workspace = true
 readme = "README.md"
-authors = [
-    "Erhan Tezcan <[email protected]>",
-    "Anil Altuner <[email protected]",
-]
+authors = ["Erhan Tezcan <[email protected]>"]
 
 # profiling build for flamegraphs
 [profile.profiling]

compute/Cargo.toml

@@ -4,7 +4,10 @@ version = "0.1.0"
 edition.workspace = true
 license.workspace = true
 readme = "README.md"
-authors = ["Erhan Tezcan <[email protected]>"]
+authors = [
+    "Erhan Tezcan <[email protected]>",
+    "Anil Altuner <[email protected]",
+]
 
 [dependencies]
 libp2p = { git = "https://github.com/anilaltuner/rust-libp2p.git", rev = "7ce9f9e", features = [
@@ -25,7 +28,8 @@ libp2p = { git = "https://github.com/anilaltuner/rust-libp2p.git", rev = "7ce9f9
     "kad",
 ] }
 libp2p-identity = { version = "0.2.9", features = ["secp256k1"] }
-
-env_logger.workspace = true
 log.workspace = true
 eyre.workspace = true
+
+[dev-dependencies]
+env_logger.workspace = true

p2p/Cargo.toml

@@ -2,11 +2,11 @@ use std::collections::hash_map;
 use std::hash::{Hash, Hasher};
 use std::time::Duration;
 
-use libp2p::identity::{Keypair, PublicKey};
+use libp2p::identity::{Keypair, PeerId, PublicKey};
 use libp2p::kad::store::MemoryStore;
-use libp2p::{autonat, dcutr, gossipsub, identify, kad, relay, swarm::NetworkBehaviour, PeerId};
+use libp2p::{autonat, dcutr, gossipsub, identify, kad, relay, swarm::NetworkBehaviour};
 
-use super::{P2P_KADEMLIA_PROTOCOL, P2P_PROTOCOL_STRING};
+use crate::versioning::{P2P_KADEMLIA_PROTOCOL, P2P_PROTOCOL_STRING};
 
 #[derive(NetworkBehaviour)]
 pub struct DriaBehaviour {
@@ -119,9 +119,8 @@ fn create_gossipsub_behavior(author: PeerId) -> gossipsub::Behaviour {
     /// This helps to avoid memory exhaustion during high load
     const MAX_SEND_QUEUE_SIZE: usize = 400;
 
-    // message id's are simply hashes of the message data
+    // message id's are simply hashes of the message data, via SipHash13
     let message_id_fn = |message: &Message| {
-        // uses siphash by default
         let mut hasher = hash_map::DefaultHasher::new();
         message.data.hash(&mut hasher);
         let digest = hasher.finish();

p2p/src/behaviour.rs

@@ -12,6 +12,7 @@ use libp2p::{Multiaddr, PeerId, Swarm, SwarmBuilder};
 use libp2p_identity::Keypair;
 use std::time::Duration;
 use std::time::Instant;
+use versioning::{P2P_KADEMLIA_PREFIX, P2P_KADEMLIA_PROTOCOL, P2P_PROTOCOL_STRING};
 
 /// P2P client, exposes a simple interface to handle P2P communication.
 pub struct DriaP2P {

p2p/src/client.rs

@@ -1,14 +1,12 @@
+mod transform;
+mod versioning;
+
 mod behaviour;
 pub use behaviour::{DriaBehaviour, DriaBehaviourEvent};
 
 mod client;
 pub use client::DriaP2P;
 
-mod versioning;
-pub use versioning::*;
-
-mod transform;
-
 // re-exports
 pub use libp2p;
 pub use libp2p_identity;

p2p/src/lib.rs

@@ -10,7 +10,6 @@ authors = ["Erhan Tezcan <[email protected]>"]
 [dependencies]
 tokio-util.workspace = true
 tokio.workspace = true
-parking_lot.workspace = true
 serde.workspace = true
 serde_json.workspace = true
 async-trait.workspace = true

workflows/Cargo.toml

@@ -6,14 +6,27 @@ This crate handles the configurations of models to be used, and implements vario
 - **OpenAI**: We check that the chosen models are enabled for the user's profile by fetching their models with their API key. We filter out the disabled models.
 - **Ollama**: We provide a sample workflow to measure TPS and then pick models that are above some TPS threshold. While calculating TPS, there is also a timeout so that beyond that timeout the TPS is not even considered and the model becomes invalid.
 
-## Environment Variables
+## Installation
+
+TODO: !!!
+
+## Usage
 
 DKN Workflows make use of several environment variables, respecting the providers.
 
 - `OPENAI_API_KEY` is used for OpenAI requests
 - `OLLAMA_HOST` is used to connect to Ollama server
 - `OLLAMA_PORT` is used to connect to Ollama server
 - `OLLAMA_AUTO_PULL` indicates whether we should pull missing models automatically or not
+- `SERPER_API_KEY` is optional API key to use **Serper**, for better Workflow executions
+- `JINA_API_KEY` is optional API key to use **Jina**, for better Workflow executions
+
+With the environment variables ready, you can simply create a new configuration and call `check_services` to ensure all models are correctly setup:
+
+```rs
+use dkn_workflows::{DriaWorkflowsConfig, Model};
 
-SERPER_API_KEY=
-JINA_API_KEY=
+let models = vec![Model::Phi3_5Mini];
+let mut config = DriaWorkflowsConfig::new(models);
+config.check_services().await?;
+```

workflows/README.md

@@ -1,6 +1,5 @@
-use dkn_workflows::{DriaWorkflowsConfig, ModelProvider};
+use dkn_workflows::{DriaWorkflowsConfig, Model, ModelProvider};
 use eyre::Result;
-use ollama_workflows::Model;
 use std::env;
 
 const LOG_LEVEL: &str = "none,dkn_workflows=debug";