examples, docstrings, comments

Author: victor-shepardson

examples/notepredictor/autopitch.scd

@@ -1,3 +1,14 @@
+// in this example the Linnstrument displays an interface to perform pitches
+// by their likelihood under the NotePredictor model instead of by MIDI number
+
+// the grid in the upper left gives control of pitches from
+// the single most likely (cyan) to least likely (pink).
+
+// the white pad samples pitches stochastically from the model.
+// the lone yellow pad resets the model.
+
+// model predictions are conditioned on performed timing and velocity.
+
 (
 ~use_linn = true; // use linnstrument
 ~gui = false; // use keyboard GUI
@@ -93,7 +104,7 @@ b.sendMsg("/predictor/predict",
 (
 ~gate = 1;
 
-~reset = {
+~model_reset = {
     ~last_pitch = nil;
     ~last_dt = nil;
     ~last_vel = nil;
@@ -105,7 +116,7 @@ b.sendMsg("/predictor/predict",
 
 };
 
-~reset.();
+~model_reset.();
 
 // footswitch
 MIDIdef.program(\switch, {
@@ -178,7 +189,7 @@ OSCdef(\return, {
 }, "/prediction", nil);
 )
 
-~reset.()
+~model_reset.()
 // send a note manually if you don't have a midi controller
 MIDIdef.all[\input].func.(64, 16) //velocity, "pitch"
 

examples/notepredictor/linnstrument-display.scd

@@ -1,3 +1,6 @@
+// in this example, the most likely next pitches (according to NotePredictor)
+// are drawn on the Linnstrument as you play
+
 (
 ~use_linn = true; // use linnstrument
 ~gui = false; // use keyboard GUI
@@ -19,7 +22,7 @@ Server.default.options.outDevice_("Built-in Output");
         // release the previous note
         ~synth!?(_.release(0.1));
 
-        // attack the current note with the old pitch
+        // attack the current note
         ~synth = Synth(\pluck, [\freq, freq, \vel, amp]);
 
         //
@@ -46,40 +49,11 @@ s.waitForBoot{
 };
 )
 
-~linn_reset.()
-
-
-// ~linn.setNoteOnAction({}); ~linn.setNoteOffAction({});
-
-
-// measure round-trip latency
-(
-OSCdef(\return, {
-    arg msg, time, addr, recvPort;
-    (Process.elapsedTime - t).postln;
-}, '/prediction', nil);
-t = Process.elapsedTime;
-b.sendMsg("/predictor/predict",
-    \pitch, 60+12.rand, \time, 0, \vel, 0,
-    \index_pitch, 0,
-    \sweep_time, true,
-    // \fix_time, 0,
-    // \fix_vel, 0
-);
-)
-
-
-// NetAddr.localAddr    // retrieve the current IP and port
-// thisProcess.openPorts; // list all open ports
-
-// model chooses pitches
 (
 // set the delay for more precise timing
 ~delay = 0.2;
 
-~gate = 1;
-
-~reset = {
+~model_reset = {
     t = Process.elapsedTime;
     b.sendMsg("/predictor/reset");
     // ~synth!?{~synth.free};
@@ -90,33 +64,18 @@ b.sendMsg("/predictor/predict",
         \pitch_topk, 5);
 
 };
-~reset.();
+~model_reset.();
 ~linn_reset.();
 
-// footswitch
-MIDIdef.program(\switch, {
-    arg num, chan, src;
-    num.switch
-    {1}{~gate = 0}
-    {2}{~gate = 1}
-    {3}{
-        ~gate = 0;
-        SystemClock.clear;
-        b.sendMsg("/predictor/reset");
-        y.release;
-        SystemClock.clear;
-        };
-    ~gate.postln;
-});
-
 // OSC return from python
 OSCdef(\return, {
     arg msg, time, addr, recvPort;
     var pitches, dts;
     var last_pitch = nil;
     var colormap = [8,3,10,9,1];
     var color = 0;
-    // whhyyyy are OSC arrays not handled by supercollider
+
+    // OSC arrays are not handled automatically by supercollider
     var stack = List[List[]];
     msg.do{arg item;
         case
@@ -125,6 +84,7 @@ OSCdef(\return, {
         {true}{stack.last.add(item)};
     };
     msg = stack[0];
+
     pitches = msg[1];
     dts = msg[2];
 
@@ -141,9 +101,27 @@ OSCdef(\return, {
 }, "/prediction", nil);
 )
 
-~reset.()
+
+
+// ======
+// additional useful blocks
+
+~model_reset.()
 // send a note manually if you don't have a midi controller
 MIDIdef.all[\input].func.(64, 16) //velocity, "pitch"
 
-// load another model
-// b.sendMsg("/predictor/load", "/path/to/checkpoint");
+// measure round-trip latency
+(
+OSCdef(\return, {
+    arg msg, time, addr, recvPort;
+    (Process.elapsedTime - t).postln;
+}, '/prediction', nil);
+t = Process.elapsedTime;
+b.sendMsg("/predictor/predict",
+    \pitch, 60+12.rand, \time, 0, \vel, 0,
+    \index_pitch, 0,
+    \sweep_time, true,
+    // \fix_time, 0,
+    // \fix_vel, 0
+);
+)

examples/notepredictor/midi-duet.scd

@@ -1,3 +1,6 @@
+// in this example the model's predictions are fed back to it so it plays itself.
+// the player can add notes as well and start/stop/reset the model with a footswitch.
+
 (
 ~gui = false;
 MIDIIn.connectAll;
@@ -36,9 +39,6 @@ b.sendMsg("/predictor/predict", \pitch, 60+12.rand, \time, 0, \vel, 0);
 // set the delay for more precise timing
 ~delay = 0.015;
 
-// NetAddr.localAddr    // retrieve the current IP and port
-// thisProcess.openPorts; // list all open ports
-
 // duet with the model
 // feeds the model's predictions back to it as well as player input
 (

notepredictor/notepredictor/model.py

@@ -321,7 +321,9 @@ def predict(self,
             time: float. elapsed time since previous note.
             vel: float. (possibly dequantized) MIDI velocity from 0-127 inclusive.
             fix_*: same as above, but to fix a value for the predicted note
-            index_pitch: Optional[int]. if not None, determinisitically take the nth
+            pitch_topk: Optional[int]. if not None, instead of sampling pitch, stack
+                the top k most likely pitches along the batch dimension
+            index_pitch: Optional[int]. if not None, deterministically take the nth
                 most likely pitch instead of sampling.
             allow_start: if False, zero probability for sampling the start token
             allow_end: if False, zero probaility for sampling the end token
@@ -372,7 +374,7 @@ def predict(self,
 
             # permute h_tgt, embs, modalities
             # if any modalities are determined, embed them
-            # sort constrained modailities before unconstrained
+            # sort constrained modalities before unconstrained
             # TODO: option to skip modalities
             det_idx, cons_idx, uncons_idx = [], [], []
             for i,(item, embed) in enumerate(zip(fix, self.embeddings)):
@@ -414,21 +416,18 @@ def predict(self,
                     context.append(embed(pred))
                 det_idx.append(i)
 
-
             pred_pitch = predicted[iperm[0]]
             pred_time = predicted[iperm[1]]
             pred_vel = predicted[iperm[2]]
 
-            print(pred_time.shape)
-            print(pred_pitch.shape)
-            print(pred_vel.shape)
-
             if sweep_time or pitch_topk:
+                # return lists of predictions
                 pred_pitch = [x.item() for x in pred_pitch]
                 pred_time = [x.item() for x in pred_time]
                 pred_vel = [x.item() for x in pred_vel]
                 print(pred_time, pred_pitch, pred_vel)
             else:
+                # return single predictions
                 pred_pitch = pred_pitch.item()
                 pred_time = pred_time.item()
                 pred_vel = pred_vel.item()