semvec/pypi-packages huggingface dataset:
mara-markdown-docs 0.9.0
Display markdown documentation in mara UI
License: MIT
Requires Python: >=3.7

# Mara Markdown Documentation

Display markdown documentation in mara UI

[![Build Status](https://travis-ci.org/jankatins/mara-markdown-docs.svg?branch=master)](https://travis-ci.org/jankatins/mara-markdown-docs)
[![PyPI - License](https://img.shields.io/pypi/l/mara-markdown-docs.svg)](https://github.com/jankatins/mara-markdown-docs/blob/master/LICENSE)
[![PyPI version](https://badge.fury.io/py/mara-markdown-docs.svg)](https://badge.fury.io/py/mara-markdown-docs)
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://communityinviter.com/apps/mara-users/public-invite)


This package displays configured documentation in markdown format in the UI:

- Convert markdown to html via [markdown-it](https://github.com/markdown-it/markdown-it)
- Supports a folder structure (single level) in the menu
- Supports [mermaid](https://mermaid-js.github.io/mermaid/#/) diagrams
- Serves referenced images (`.png`, `.jpg`, `.gif`) in markdown and `.txt` files (for example config, etc) 
  if these are in the same folder as the markdown file

&nbsp;

## Screenshot

![Screenshot](mara-markdown-docs_800px.png) 

&nbsp;

## Installation

To use the library directly, use pip:

```
python3 -m pip install mara-markdown-docs

# or directly from git
python3 -m pip install git+https://github.com/mara/mara-markdown-docs.git
```

&nbsp;

## Configuration

Assuming you configure via `app/local_setup.py`:

```python
"""Configures the docs functionality"""

import pathlib
from mara_app.monkey_patch import patch

import mara_markdown_docs.config

@patch(mara_markdown_docs.config.documentation)
def documentation() -> dict:
    """Dict with name -> path to markdown file.

    If name contains a single '/' it will be shown in a submenu. Multiple '/' are not allowed.
    The insertion order is mostly preserved (folders are grouped in the menu)."""

    repo_root_dir = pathlib.Path(__file__).parent.parent

    # Cases matter in path!
    docs = {
        'Pipeline/Marketing': repo_root_dir / 'app/pipelines/marketing/README.md',
        'Developer/Setup': repo_root_dir / 'README.md',
        'Developer/Code Conventions': repo_root_dir / 'code_conventions.md',
    }

    return docs
```
kdlutils 1.5.7
This library has several helper functions for deep learning
License: MIT
Keywords: Deep Learning,Helper functions

githubActions
=============

This repository contains a small collection of utility functions.

Installing the library in colab
===============================

.. code:: shell

    !git clone https://github.com/kaustubh-sadekar/dlutils.git
    !sudo python3 dlutils/setup.py install

Example code for testing in colab
=================================

.. code:: python

    import sys
    sys.path.append("dlutils/")
    import kdlutils
    input_dim = (1,600,800)
    layersList = [{'conv':(1,7,3,1,1,1)},{'mp':(2,2,0,1)},{'conv':(7,14,3,1,1,1)},{'mp':(2,2,0,1)},{'conv':(14,30,3,1,1,1)},{'mp':(2,2,0,1)}]
    out = kdlutils.kdlutils.getOutShape(input_dim,layersList)
    print(out)

Documentation and new codes will be uploaded soon.