Update readme, remove release field info

README.md

@@ -35,7 +35,7 @@ configs:
 
 ## Dataset Summary
 
-The Chords from the Lakh MIDI Dataset (LMD) is a collection of 30000+ chord sequences extracted from selected MIDI files of the [Lakh MIDI Dataset](https://colinraffel.com/projects/lmd/)
+The Chords from the Lakh MIDI Dataset (LMD) is a collection of 31032 chord sequences extracted from selected MIDI files of the [Lakh MIDI Dataset](https://colinraffel.com/projects/lmd/)
 extracted using the Python library [chord-extractor](https://github.com/ohollo/chord-extractor), which has the ability to take MIDI, MP3, WAV and other 
 sound files in bulk, and extract chords using the [Chordino](https://code.soundsoftware.ac.uk/projects/nnls-chroma/) method. 
 
@@ -48,9 +48,8 @@ metadata associated with the chord sequences.
 
 ### Data Instances
 
-A typical data point comprises the chords with when they occur in the song, IDs so that one can source the metadata or
+A typical data point comprises the chord sequences (with when they occur in the song), IDs so that one can source the metadata or
 actual MIDI files themselves, along with some information about the original piece of music that the MIDI is based on. 
-MIDI files comprising the LMD. 
 
 An example from the dataset looks as follows:
 ```
@@ -59,11 +58,10 @@ An example from the dataset looks as follows:
   'artist': 'Billy Joel',
   'track_id': 'TRNCSKU128F4265639',
   'year': 1977,
-  'release': 'The Stranger',
   'song_id': 'SOIJWHG12A8C134063',
   'chords': {
       'symbol': ['N', Dm', 'Bb', 'C','Eaug', 'Am', 'Dm', 'Gm7', 'C', 'Eaug', 'Am', ...],
-      'timestamp': [0.4643990993499756, 1.8575963973999023, 3.7151927947998047, 4.551111221313477, ...]
+      'timestamp': [0.371519274, 0.4643990993499756, 1.8575963973999023, 3.7151927947998047, 4.551111221313477, ...]
   }
 }
 ```
@@ -74,41 +72,36 @@ An example from the dataset looks as follows:
 - `artist`: Artist/performer of the song.
 - `track_id`: The track ID as used by Echo Nest, a source of data for the Million Song Dataset. This is also important as 
 it is used in LMD's "LMD-matched" dataset as the directory names containing the MIDIs corresponding to a particular song from the MSD.
- Therefore one can use this to navigate those files.
-- `year`: Year that the song was first released (see considerations) as provided. If not provided by MSD, this 
-is denoted 0. 16832 of 31032 records have years.
-- `release`: Album or song collection provided by MSD which contains song. Note, this is often not 
-the album that the song was originally released from (it may be the album that contains the particular
-version transcribed in the MIDI - see considerations).
+ Therefore use this to navigate those files.
+- `year`: Year that the song was first released (see considerations) if provided. If not provided by MSD, this 
+is denoted 0. Of 31032 total records, 16832 have years.
 - `song_id`: "Song ID" as provided by the Million Song Dataset. 
 - `chords`: Two lists of same length describing chord progressions in song
   - `symbol`: List of chord symbols in the order as they appear in the song. 
-The list is bookended with two dummy 'N' symbols to assist with when the track starts and ends.
+The list is bookended by Chordino with two dummy 'N' symbols to assist with when the track starts and ends.
   - `timestamp`: Timestamps (in seconds) at which the chords appear in the song. The index of the timestamp,
-corresponds to the chord symbol in the same index in "symbol".
+corresponds to the chord symbol in the same index as "symbol".
 
 
 ### Data Splits
 
-The data currently only has one split - "train".
+The data currently has one split - "train".
 
 ## Dataset Creation
 
 ### Curation Rationale
 
 The LMD Chords are created to provide a chord sequence dataset of reasonable size such that potentially good insights 
-can be made into harmonic progression, and furthermore across different categories, provided metadata about the song be discoverable. 
-To this end, a collection of music files from which 
-to extract chords from was sought, one that could be of sufficient size, and which give a decent representation of
-different genres, years, artists etc. The songs in the LMD (those matched with MSD) satisfy these requirements to a 
-large extent.
+can be made into harmonic progression. Enhanced analysis is also possible with the timestamps of these chords provided.
+The selection of files matched with MSD should give a decent representation of different genres, years, artists etc. 
 
-With the lack of sizeable publicly available datasets with the actual original songs, for example in MP3 format, 
-MIDIs are seen as a viable alternative, as they should relay the notes played in the song, despite not being timbrally the same as the original.
+With the lack of accessible large publicly available datasets with the actual original songs, for example in MP3 format, 
+MIDIs are seen as a viable alternative, as they should relay the notes played in the song, despite not being timbrally 
+the same as the original.
 
-Furthermore, the IDs of the Million Song Dataset provided gives the user the opportunity to map to the wealth of audio 
+Furthermore, the IDs of the Million Song Dataset provided give the user the opportunity to map the chords to the wealth of audio 
 analysis held in the full version of the MSD. These not only include an expanded version of the metadata provided here,
-but features such as tempo, key, loudness and much more, though not explictly the chords, hence the existence of this dataset.
+but features such as tempo, key, loudness and much more.
 
 
 ### Source Data
@@ -123,12 +116,12 @@ on the [LMD website](https://colinraffel.com/projects/lmd/).
 the associated MSD record. This JSON file contains a map between MSD/Echo Nest track IDs and the associated MIDI filenames
 in LMD and their score.
 - The Summary File of the whole Million Song Dataset, available on [this page](http://millionsongdataset.com/pages/getting-dataset/).
-Note this is a 300MB HDF5 with just the metadata. The whole MSD (which is 280GB) is not needed.
+Note this is a 300MB HDF5 with just the metadata. The whole MSD (which is 280GB) is not needed to create this dataset.
 
 The LMD Chords dataset only uses one MIDI per song. The Match Scores file was used to see the
-best matching file to a particular song from MSD, and that file was used here. 
+best matching MIDI to a particular song from MSD, and that file was then included here. 
 
-The directory name for that holding a particular MIDI is the track ID for that song used by MSD, and therefore was used
+The name of a directory holding a particular MIDI is the same as the track ID for that song used by MSD, and therefore was used
 to map a MIDI file to the MSD and source its metadata.
 
 #### Chord Extraction Process
@@ -148,27 +141,26 @@ Please refer to [this website](https://code.soundsoftware.ac.uk/projects/nnls-ch
 
 ## Considerations for Using the Data
 
-### Accuracy of the Chord Extractions
+### Limitations of the Chord Extractions
 
 The chords listed here are interpretations made by the Chordino method, an algorithm applied to sound files, and as such
 will likely deviate from official transcriptions and scores. The chord symbols effectively provide root notes, differentiations 
 between major and minor chords, major and dominant 7ths, as well as providing slash chords, and some others, the chords 
-types available are not exhaustive. It is not able for example to identify complex jazz chords such as Fmaj7#11. The 
-frequency at which new chords are detected, may err on the sensitive side based on the settings used in extraction.
+types available are not exhaustive. It is not able for example to identify complex jazz chords such as Fmaj7#11. 
 
 It should also be noted that the MIDIs were converted to WAV sound files prior to extraction (as this was the format 
-needed by chord-extractor). In that way some information may be lost, compared to say directly gleaning chords from 
+needed by chord-extractor). In that way some information may be lost, compared to directly gleaning chords from 
 reading the note information available in the MIDI file.
 
 Nevertheless, the extractions are of sufficient quality to give a good semblance of the "ground truth", particularly for
-harmonically non-complex songs (and for the complex, even humans would disagree with each other over the exact interpretations 
-of the chords). In that way, the dataset should hold some value for analysis and predictive models.
+harmonically non-complex songs, which form the majority. The user is encouraged to compare some of the extractions here to their expectations.
 
 
 ### Accuracy of the Metadata
 
-It should be noted that though the Million Song Dataset has sourced its metadata from a good source (The Echo Nest), it
-is not immune from the occasional typo, though this is observed to be very rare. Other metadata can be open to interpretation (e.g. genre).
+It should be noted that though the Million Song Dataset has sourced its metadata from The Echo Nest, it
+is not immune from the occasional typo, though this is observed to be very rare with regard to song name and artist. 
+Other metadata in MSD can be open to interpretation (e.g. genre).
 The user should familiarise themselves with how MSD has populated a field, if heavily relying on its data. 
 The year field as relayed in this dataset is a good example of this. It is only present for approximately half of the data points,
 and though it is assumed to show the original year of the song's release, it should be verified that this is always the case.
@@ -194,17 +186,20 @@ The dataset is licensed under CC BY-SA 4.0. Please review the license for detail
 
 ### Citation Information
 
-If using this dataset, please cite it:
+If using this dataset, please cite it by getting the latest Bibtex from the "Cite this dataset" button on this page.
+It should resemble the following:
 
 ```
-@dataset{lmd_chords,
-  author    = {Oliver Holloway},
-  title     = {Chords from the Lakh MIDI Dataset},
-  publisher = {Hugging Face},
-  url       = {https://huggingface.co/datasets/lmd_chords},
+@misc {oliver_holloway_2025,
+	author       = { {Oliver Holloway} },
+	title        = { lmd_chords (Revision 4d6815c) },
+	year         = 2025,
+	url          = { https://huggingface.co/datasets/ohollo/lmd_chords },
+	doi          = { 10.57967/hf/4219 },
+	publisher    = { Hugging Face }
 }
 ```
-and the [chord-extractor Python library](https://github.com/ohollo/chord-extractor).
+It would be great to mention the [chord-extractor Python library](https://github.com/ohollo/chord-extractor) as well.
 
 Furthermore, this dataset is derived from the [Lakh MIDI Dataset](https://colinraffel.com/projects/lmd/) so please cite the below:
 

expt.json

@@ -1,3 +0,0 @@
-{"id":1,"sequence":[{"chord":"S","time":2.0},{"chord":"S","time":2.0}]}
-{"id":2,"sequence":[{"chord":"S","time":2.0},{"chord":"S","time":2.0},{"chord":"S","time":2.0}]}
-{"id":3,"sequence":[{"chord":"S","time":2.0},{"chord":"S","time":2.0},{"chord":"S","time":2.0}]}