Skip to content

Latest commit

 

History

History
97 lines (58 loc) · 2.78 KB

Documentation.md

File metadata and controls

97 lines (58 loc) · 2.78 KB

Documentation Example

Some introductory sentence(s). Data set and task are relatively fixed, so probably you don't have much to say about them (unless you modifed them). If you haven't changed the application much, there's also not much to say about that. The following structure thus only covers preprocessing, feature extraction, dimensionality reduction, classification, and evaluation.

Evaluation

Design Decisions

Which evaluation metrics did you use and why? Which baselines did you use and why?

Results

How do the baselines perform with respect to the evaluation metrics?

Interpretation

Is there anything we can learn from these results?

Preprocessing

I'm following the "Design Decisions - Results - Interpretation" structure here, but you can also just use one subheading per preprocessing step to organize things (depending on what you do, that may be better structured).

Design Decisions

Which kind of preprocessing steps did you implement? Why are they necessary and/or useful down the road?

Results

Maybe show a short example what your preprocessing does.

Interpretation

Probably, no real interpretation possible, so feel free to leave this section out.

Feature Extraction

Again, either structure among decision-result-interpretation or based on feature, up to you.

Design Decisions

Which features did you implement? What's their motivation and how are they computed?

Results

Can you say something about how the feature values are distributed? Maybe show some plots?

Interpretation

Can we already guess which features may be more useful than others?

Dimensionality Reduction

If you didn't use any because you have only few features, just state that here. In that case, you can nevertheless apply some dimensionality reduction in order to analyze how helpful the individual features are during classification

Design Decisions

Which dimensionality reduction technique(s) did you pick and why?

Results

Which features were selected / created? Do you have any scores to report?

Interpretation

Can we somehow make sense of the dimensionality reduction results? Which features are the most important ones and why may that be the case?

Classification

Design Decisions

Which classifier(s) did you use? Which hyperparameter(s) (with their respective candidate values) did you look at? What were your reasons for this?

Results

The big finale begins: What are the evaluation results you obtained with your classifiers in the different setups? Do you overfit or underfit? For the best selected setup: How well does it generalize to the test set?

Interpretation

Which hyperparameter settings are how important for the results? How good are we? Can this be used in practice or are we still too bad? Anything else we may have learned?