Starting adding documentation to the README file

README.md

@@ -20,7 +20,7 @@ By the use of the aforementioned autoencoder, it allows the user to encode piano
 ### Model Description
 
 <figure>
-<img src="https://huggingface.co/TomRB22/pivaenist/resolve/main/.images/architecture.png" style="width:100%">
+<img src="https://huggingface.co/TomRB22/pivaenist/resolve/main/.images/architecture.png" style="width:100%; display:block; margin:auto">
 <figcaption align = "center"><b>Pivaenist's architecture.</b></figcaption>
 </figure>
 
@@ -30,8 +30,6 @@ By the use of the aforementioned autoencoder, it allows the user to encode piano
 
 ### Sources
 
-<!-- Provide the basic links for the model. -->
-
 **Code:** Some of the code of this repository includes modifications (not the entire code, due to the differences in the architecture) or implementations from the following sites:
 1. [TensorFlow. (n.d.). Generate music with an RNN | TensorFlow Core](https://www.tensorflow.org/tutorials/audio/music_generation) - Tensorflow tutorial where pretty-midi is used
 2. [Han, X. (2020, September 1). VAE with TensorFlow: 6 Ways](https://towardsdatascience.com/vae-with-tensorflow-6-ways-9c689cb76829) - VAE explanation and code
@@ -39,45 +37,12 @@ By the use of the aforementioned autoencoder, it allows the user to encode piano
 
 There might be acknowledgments missing. If you find some other resemblance to a site's code, please notify me and I will make sure of including it.
 
-## Uses 
-<!-- MENTION COLAB HERE -->
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
 
 ### Using pivaenist in colab
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
 If you preferred directly using or testing the model without the need to install it, you can use the following colab notebook and follow its instructions. Moreover, this serves as an example of use.
 [colab link]
 
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
 ## Installation
 
 To install the model, you will need to **change your working directory to the desired installation location** and execute the following commands:
@@ -105,133 +70,38 @@ The first one will clone the repository. Then, fluidsynth, a real-time MIDI synt
 Pivaenist was trained on the [MAESTRO v2.0.0 dataset](https://magenta.tensorflow.org/datasets/maestro), which contains 1282 midi files [check it in colab]. Their preprocessing involves splitting each note in pitch, duration and step, which compose a column of a 3xN matrix (which we call song map), where N is the number of notes and a row represents sequentially the different pitches, durations and steps. The VAE's objective is to reconstruct these matrices, making it then possible to generate random maps by sampling from the distribution, and then convert them to a MIDI file.
 
 <figure>
-<img src="https://huggingface.co/TomRB22/pivaenist/resolve/main/.images/map_example.png" style="width:50%">
-<figcaption align = "center"><b>A cropped example of a song map.</b></figcaption>
+    <img src="https://huggingface.co/TomRB22/pivaenist/resolve/main/.images/map_example.png" style="width:30%; display:block; margin:auto">
+    <figcaption align = "center"><b>A horizontally cropped example of a song map.</b></figcaption>
 </figure>
 
-### Training Data
-
-<!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure 
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Data Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
+# Documentation
 
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
+## **_Audio_**
 
-#### Hardware
+### midi_to_notes
 
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
+```python
+def midi_to_notes(midi_file: str) -> pd.DataFrame:
+```
+Convert midi file to "song map" (dataframe where each note is broken
+into its components)
 
-## Model Card Authors [optional]
+Parameters:
+* midi_file (str): Path to the midi file.
 
-[More Information Needed]
+Returns:
+* pd.Dataframe: 3xN matrix where each column is a note, composed of pitch, duration and step.
 
-## Model Card Contact
+### display_audio
 
-[More Information Needed]
+```python
+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.
 
-## Documentation
+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.
 
-### 
+Returns
+* display.Audio: Song as an object allowing for display.