XML Book Documentation¶
Welcome to the XML book documentation. If you are looking for the book itself, navigate to book.xmlx.dev.
Repository Structure¶
The book has two main components:
- content authored in Jupyter Book and published at book.xmlx.dev; and
- documentation built with MkDocs and accessible at book.xmlx.dev/docs.
The book source is stored in the book directory and
the documentation source is kept in the docs directory
of the xmlx-dev/xml-book GitHub repository.
We keep the documentation separate to ensure a clean structure and immersive
experience when reading the book.
About the Documentation¶
This documentation covers technical concepts to do with how the book is built and maintained, as well as a contributor’s guide that outlines how to author new content for the book. In particular, you will find here a code of conduct, changelog, ways to contact us and acknowledgements. The documentation also includes a dedicated page describing our preferred contribution workflow and information how to set up your development environment. There are specific pages for working with the documentation and the book.
Reporting an Issue¶
If you find a typographical error or a conceptual mistake in the book, please open a GitHub issue to inform us about it – there are a number of predefined templates to help you with reporting. If the problem requires more effort than just a few simple text edits and you are happy to fix it yourself, please visit the development page to get started.
Licence¶
The book is licenced under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International. Contributors are required to accept and sign Apache Individual Contributor Licence Agreement 2.2 – see here for more details. This arrangement allows us to offer the book online for free. The code is licenced under MIT.
Commercial Use
If you would like to use the book for purposes (e.g., commercial) that fall outside of the scope of this licence, please get in touch to discuss your individual situation. We are also happy to offer bespoke courses and training sessions based on the book content, either on-premise or as an online seminar.
Disclaimer of Warranties and Limitation of Liability
In accordance with Section 5 of the licence, the book is offered by the Licensor as-is and as-available, and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the Licensor be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this book, even if advised of the possibility of such damage.
Citing the Book¶
If you happen to use this book as part of your research, please make sure to cite us.
@book{sokol2022xml,
author = {Sokol, Kacper and XMLX Team},
title = {{E}xplainable {M}achine {L}earning},
year = {2022},
url = {https://book.xmlx.dev/}
}