Open miquelduranfrigola opened 3 months ago
This is clear to me, Let me work on it.
Hello @miquelduranfrigola, The PR is for implementing the CLI. From today's meeting, the action is to update it and ensure comprehensive reporting at all stages(including interpretability plots at inference time). I'm updating it. I will ping you once done.
Hi @HellenNamulinda and @GemmaTuron
Find below a suggested outline of the features that XAI4Chem must have, and of the different examples we will offer in the MSc project.
Components
The workflow is composed of 3 steps:
API and CLI
The package can be run as a CLI or as a Python API.
CLI
We should design a command similar to this:
xai4chem train --input_file $INPUT_FILE --output_dir $OUTPUT_DIR --representation morgan_fingerprint
With new samples, we should work as follows:
xai4chem infer --input_file $INPUT_FILE --model_dir $MODEL_DIR --output_dir $OUTPUT_DIR
Note that, at inference time, the
$MODEL_DIR
is the$OUTPUT_DIR
obtained at training time.Python API
With the Python API, we need 3 main modules (representation, supervised and reporting) with classes corresponding to each specific method. Importantly, all classes within a module need to have the same parameters.
MorganFingerprint
,DatamolDescriptor
, etc. Descriptors and fingerprints should work with afit
andtransform
logic.Classifier
andRegressor
classes.Reporter
class having atables
and afigures
method.Case examples