Skip to content

Commit

Permalink
delete jsymbollic
Browse files Browse the repository at this point in the history
  • Loading branch information
martianbug committed Dec 11, 2023
1 parent c7077b8 commit 071b865
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 17 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ To install the latest version of musif, just run
which will download musif and all its necessary dependencies.

## music21 and jsymbollic features
Currently, musif is able to process and integrate basic music21 features.
Currently, musif is able to process and integrate basic music21 features.

For jsymbollic features, musif currently does not support the integration of these features, but a tutorial will be provided to manually merge them into musif's dataframe.
# jsymbollic installation
Java JRE >= 8 must be installed in your OS. Download Java Development Kit: https://www.oracle.com/es/java/technologies/downloads/
Expand Down
17 changes: 2 additions & 15 deletions docs/source/Feature_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,11 @@ Finally, the _Stock module_ column lists the module distributed in `musif` and t
Note that none of these features works on percussion instruments.

In addition to the features in the present page, the features in the `'music21'` stock
module (first row of the below table) provide all the features from [`music21.features.native`](http://web.mit.edu/music21/doc/moduleReference/moduleFeaturesNative.html)
and [`music21.features.jSymbolic`](http://web.mit.edu/music21/doc/moduleReference/moduleFeaturesJSymbolic.html). The stock module
`'jsymbolic`, instead, provide the features extracted using
[`jSymbolic`](https://jmir.sourceforge.net/manuals/jSymbolic_manual/featureexplanations_files/featureexplanations.html) in the default configuration.

You can provide custom `jSymbolic` configurations using the `jsymbolic_config_file` and `jsymbolic_max_ram` options in the [extraction configuration](Configuration.html).
When you use both the `jsymbolic` and `music21` features, `music21.features.jSymbolic`
is disabled, as it corresponds to a subset of musif's `jsymbolic` module.

For the `jsymbolic` stock module, jSymbolic will be downloaded at the first run and you
will need Java JRE >= 8 installed in your OS. You can force the download of jSymbolic
and the check of Java installation by running `python -m
musif.extract.features.jsymbolic`.

module (first row of the below table) provide all the features from [`music21.features.native`](http://web.mit.edu/music21/doc/moduleReference/moduleFeaturesNative.html).

| **Column RegEx** | **Explanation** | Stock module |
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| `m21_.*` | Music21 features; only native features if `jsymbolic` is also included | `music21` |
| `m21_.*` | Music21 features | `music21` |
| `FileName` | File name of the original score | `core` |
| `Measures` | No. of measures of the piece | `core` |
| `.+_SoundingMeasures` | No. of measures that have at least one note (not all silence) for a given part | `core` |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Tutorial poprock.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1914,7 +1914,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.10.8"
},
"vscode": {
"interpreter": {
Expand Down

0 comments on commit 071b865

Please sign in to comment.