Documenting pt. 3

audio_methods.py

@@ -80,9 +80,7 @@ def display_audio(pm: pretty_midi.PrettyMIDI, seconds=-1) -> display.Audio:
       waveform_short = waveform[:seconds*_SAMPLING_RATE]
   
   return display.Audio(waveform_short, rate=_SAMPLING_RATE)
-
-
-# Define function to convert song map to wav
+    
 
 def map_to_wav(song_map: pd.DataFrame, out_file: str, velocity: int=100) -> pretty_midi.PrettyMIDI:
   """
@@ -92,7 +90,7 @@ def map_to_wav(song_map: pd.DataFrame, out_file: str, velocity: int=100) -> pret
   Parameters:
   song_map (pd.DataFrame): 3xN matrix where each column is a note, composed of
   pitch, duration and step.
-  out_file (str): Path or file to write .mid file to. If null, no saving is done.
+  out_file (str): Path or file to write .mid file to. If None, no saving is done.
   velocity: Note loudness, i. e. the hardness a piano key is struck with.
 
   Returns:
@@ -127,15 +125,25 @@ def map_to_wav(song_map: pd.DataFrame, out_file: str, velocity: int=100) -> pret
       pm.write(out_file)
   return pm
 
-def generate_and_display(out_file:str, model: VAE, out_file: str=null, z_sample: tf.Tensor=None, velocity: int=100, seconds: int=120) -> display.Audio:
+def generate_and_display(model: VAE, 
+                         out_file: str=None, 
+                         z_sample: tf.Tensor=None, 
+                         velocity: int=100, 
+                         seconds: int=120) -> display.Audio:
   """
-  Generate a song, (optionally) save it and display it [CONTINUE]
+  Generate a song, (optionally) save it and display it.
 
   Parameters:
-  
+  model (VAE): Instance of VAE to generate the song with.
+  out_file (str): Path or file to write .mid file to. If None, no saving is done.
+  z_sample (tf.Tensor): Song encoding used to generate a song. If None, perform
+                        generate an unconditioned piece.
+  velocity: Note loudness, i. e. the hardness a piano key is struck with.
+  seconds (int): Time fraction of the song to be displayed. When
+                 set to -1, the full length is taken.
 
   Returns:
-  
+  display.Audio: Song as an object allowing for display.
   """
     
   song_map = model.generate(z_sample)