|
|
[[_TOC_]]
|
|
|
|
|
|
The conML Julia project is split into two packages:
|
|
|
- **ConML.jl** serves as the basic implementation of the conML framework without any additional ML models. The framework does not work out-of-the-box on its own, so most people will want to get the second package, too, which is:
|
|
|
- **ConMLDefaults.jl**, which provides supervised and unsupervised models, feature selection and winner selection algorithms and wrappers for some Python and R packages which may be used in conjunction with ConML.jl
|
|
|
|
|
|
## Prerequesites
|
|
|
|
|
|
### ConML.jl
|
|
|
- Julia 1.5 or higher
|
|
|
- [Krippendorff.jl](https://github.com/FPGro/Krippendorff.jl/) (needs to be installed via the GitHub Link as long as it is not included in the general registry)
|
|
|
### ConMLDefaults.jl
|
|
|
- ConML.jl
|
|
|
-
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
- Get a working Julia installation of your choice. [I'll leave that to you.](https://julialang.org/downloads/)
|
|
|
- Start Julia and enter package manager mode. (usually by pressing `]`)
|
|
|
- (Set up a separate [environment](https://pkgdocs.julialang.org/v1/environments/) for conML if you want to.)
|
|
|
- If not already done, install **Krippendorff.jl**
|
|
|
```
|
|
|
add https://github.com/FPGro/Krippendorff.jl
|
|
|
```
|
|
|
- Install **ConML.jl**
|
|
|
```
|
|
|
add https://git.informatik.uni-leipzig.de/ml-group/conml/julia.git:ConML
|
|
|
```
|
|
|
- (Install **ConMLDefaults.jl**)
|
|
|
```
|
|
|
add https://git.informatik.uni-leipzig.de/ml-group/conml/julia.git:ConMLDefaults
|
|
|
```
|
|
|
- This should do the trick. If you intend to use ConMLDefaults for the first time, it will try to locate R and Python and set up the integration of the packages listed above (via [RCall.jl](https://github.com/JuliaInterop/RCall.jl) and [PyCall.jl](https://github.com/JuliaPy/PyCall.jl), respectively). If anything fails at this step, you can always try to install the required packages by hand or ignore the problems at the expense of missing out on some of the functions of ConMLDefaults.jl.
|
|
|
- Please make sure to report any problems that occur during installation including a description of your system and the installed versions of all related packages.
|
|
|
|
|
|
## Next steps
|
|
|
|
|
|
- Try to load one or both packages and see if that works. (Make sure you are not in the package manager any more, press *backspace* if necessary)
|
|
|
```
|
|
|
using ConML
|
|
|
(using ConMLDefaults)
|
|
|
```
|
|
|
- If that works, head on to the [Usage](Usage) page to continue.
|
|
|
|
|
|
## Common Issues
|
|
|
|
|
|
- If PyCall is not able to find the Scikit-Learn Python Package, this may give an error. The error is usually quite helpful in it's explanation. If it does tell you that a Sciki-Learn is missing, it also tells you which python installation is used. Locate that and install the latest Scikit-Learn version |
|
|
\ No newline at end of file |