Skip to content

Final notation / style guide #33

Open
@RaphaelS1

Description

Pinning this issue for easy reference. Collect notation and styles in this issue please.

Notation

  • Use hat notation in measures or models when referring to terms that are usually predicted (e.g., hatS in Antolini's)
  • x - scalar
  • bf{x} - vector
  • bf{X} - matrix
  • cal{X} - set
  • Use $m$ as vector length for test data
  • X - random variable (vector or scalar)
  • Use observations not random variables as standard
  • Use subscript to refer indices of a vector/matrix not superscript, e.g. x_i or x_ij
  • Use _train/_test to refer to training or test data, e.g. cal{D}_train = (x_train, y_train)
  • Introduce vectors as:

Screenshot 2024-01-11 at 12 48 00

  • I've written a macro: \dvec{a}{b} which would define \boldsymbol{a} = (a_1 \ a_2 \cdots a_{b})^\trans
  • Use \ldots instead of '...'
  • Write lists as:
  1. A;
  2. B;
  3. C.
  • Do not use contractions, e.g. 'don't' -> 'do not'
  • Use colons not dashes in lists, e.g. A: foobar; not B -- foobar

Chapter Structure

  1. Abstract (online only) ~ 300words explaining chapter in non-technical terms
  2. Introduction - Lay summary of the chapter with references to sections
  3. Main content
  4. Conclusion
    i. What we covered in the chapter
    ii. Literature and further reading

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions