Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.34 KB

File metadata and controls

55 lines (39 loc) · 2.34 KB

AI Python Developer Reference Wiki

Personal collection of documentation and reference guides for AI development with python, from PC setup guides, recommended software to install, to anything I've learned about AI training, quantization, etc.

Code Block Style Guide

This guide uses a particular style for code blocks for conveying relevant information before entering commands.

For code blocks intended for showing commands entered in an interactive environment:

```language
<comment> @ <environment>::<sub environment>::path

<commands>
```

Similarly, for files, I like to at least add the file location before showing the contents:

```language
<comment> @ path

<contents>
```

For example:

# @ environment::sub_environment::/.../path

echo "Example codeblock"
  • # @ will mean the place where the code is happening. Since it's a shell comment, a # is used but some other syntaxes use other comments
  • the environment will be things like shell or python depending on where the command is being run
  • the subsequent environments being for example, a docker container, a virtual environment, and so on.
  • the path, when relevant to the command being input, or where the file being written in the code block is saved.

This will make it more accessible to determine where something is run, even if revisiting the code block after a long time has passed.