Minor improvements to README.md

README.md

@@ -94,10 +94,10 @@ def generate(self, z_sample: tf.Tensor=None) -> tf.Tensor:
 Decode a latent representation of a song.
 
 Parameters:
-* z_sample (tf.Tensor): Song encoding outputed by the encoder. If None, this sampling is done over an unit Gaussian distribution.
+*  ``z_sample (tf.Tensor)``: Song encoding outputed by the encoder. If None, this sampling is done over an unit Gaussian distribution.
 
 Returns:
-* tf.Tensor: Song map corresponding to the encoding.
+* ``tf.Tensor``: Song map corresponding to the encoding.
 
 ## **_audio_**
 
@@ -110,10 +110,10 @@ Convert midi file to "song map" (dataframe where each note is broken
 into its components)
 
 Parameters:
-* midi_file (str): Path to the midi file.
+* ``midi_file (str)``: Path to the midi file.
 
 Returns:
-* pd.Dataframe: 3xN matrix where each column is a note, composed of pitch, duration and step.
+* ``pd.DataFrame``: 3xN matrix where each column is a note, composed of pitch, duration and step.
 
 ### display_audio
 
@@ -123,11 +123,11 @@ def display_audio(pm: pretty_midi.PrettyMIDI, seconds=-1) -> display.Audio:
 Display a song in PrettyMIDI format as a display.Audio object. This method is especially useful in a Jupyter notebook.
 
 Parameters
-* pm (pretty_midi.PrettyMIDI): PrettyMIDI object containing a song.
-* seconds (int): Time fraction of the song to be displayed. When set to -1, the full length is taken.
+* ``pm (pretty_midi.PrettyMIDI)``: PrettyMIDI object containing a song.
+* ``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.
+* ``display.Audio``: Song as an object allowing for display.
 
 ### map_to_wav
 
@@ -138,12 +138,12 @@ Convert "song map" to midi file (reverse process with respect to
 midi_to_notes) and (optionally) save it, generating a PrettyMidi object in the process.
 
 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 None, no saving is done.
-* velocity (int): Note loudness, i. e. the hardness a piano key is struck with.
+* ``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 None, no saving is done.
+* ``velocity (int)``: Note loudness, i. e. the hardness a piano key is struck with.
 
 Returns:
-* pretty_midi.PrettyMIDI: PrettyMIDI object containing the song's representation.
+* ``pretty_midi.PrettyMIDI``: PrettyMIDI object containing the song's representation.
 
 ### generate_and_display
 
@@ -157,11 +157,11 @@ def generate_and_display(model: VAE,
 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 (int): 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.
+* ``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 (int)``: 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.
+* ``display.Audio``: Song as an object allowing for display.