semvec/pypi-packages huggingface dataset:
medicraft 0.9.3
Medicraft synthetic dataset generator
License: MIT
Requires Python: <4.0,>=3.11
Keywords: diffusion, generating, medical, images, synthetic dataset, pytorch, torch, diffusion, denoising

# Medicraft


## About 

The medical imaging analysis using machine learning encounters challenges such as limited and imbalanced datasets, often constrained by privacy concerns related to patient information. The Medicraft project addresses these limitations by developing software capable of generating synthetic and diverse medical datasets from imaging information. In cooperation with the University Clinical Hospital in Poznan this tool utilizes OCT eye scans, featuring images with abnormalities like tumors and melanomas. To reduce the scarcity of real data, for medically rare cases, the solution uses diffusion models (Denoising Diffusion Probabilistic Model) to create synthetic balanced datasets which can facilitate better research and education in machine learning for medical image analysis and classification. The project uses a data-driven learning approach focused on analyzing the generated data, where synthetic images are analyzed for accuracy with the medical team, in order to achieve the best possible result.


## Documentation
The documentation for the project can be found [here](https://drfifonz.github.io/medicraft/index.html).

## Installation

###  Using conda (recomended)
 Create an environment from the `environment.yml` file:
 ```bash
 conda env create -f environment.yml
```
### Using pip
Install the required packages using pip:
```bash
pip install -r requirements.txt
```

### As a package (torch dependencies needs to be solved manually)
To install the project as a package, run the following command:
```bash
pip install medicraft
```

## Post-Installation Steps
After successfully installing Medicraft, it is highly recommended to familiarize yourself with the documentation. You can find the detailed documentation [here](https://drfifonz.github.io/medicraft/index.html).

## Usage
To learn how to run the project, refer to the usage instructions provided in the documentation [here](https://drfifonz.github.io/medicraft/usage.html).

For running a project create `config.yml` file and run the following command:
```bash
python src/main.py -f config.yml
```
See config examples here: [configs](https://drfifonz.github.io/medicraft/examples.html#example-section)




For more information on how to install the project, please refer to the [installation guide](https://drfifonz.github.io/medicraft/installation.html).

---
 ### The conference poster provides information about the project. You can find it [here](docs/conference_poster.pdf).
mkdocs-swagger-ui 0.2.4
An MkDocs plugin to generate a markdown file containing an API reference built using Swagger UI from a base OAS3 specification.
License: MIT
Requires Python: >=3.0
Keywords: mkdocs swagger api documentation

# mkdocs-swagger-ui

A MkDocs plugin created to help developer embed API Reference documentation into a mkdocs powered website. 

The output file can be modified by editing a template file.

## Setup

Install the plugin using pip:

`pip install mkdocs-swagger-ui`

Activate the plugin in `mkdocs.yml`:

```yaml
plugins:
  - swagger-ui:
      spec_url: 'https://netstorage.ringcentral.com/dpw/api-reference/specs/rc-platform.yml'
      outfile: 'docs/api.md'
```

Add the CSS file to your mkdocs.yml:

```yaml
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.43.0/swagger-ui.css
```

### Options

- `spec_url`: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only. 
- `outfile`: The file to output. This file is typically somewhere in your docs folder. 
- `template`: The name of the template file that generates the contents of the Swagger UI generated page. This file should be located in a `tmpl` directory.

More information about plugins in the [MkDocs documentation][mkdocs-plugins].

## How the plugin works

This plugin works by loading a different template and markdown file that renders a Swagger UI page in a file's place. The key to making this work is to ensure that the `outfile` plugin config value matches the filename of some file in your documentation tree, as shown below. When mkdocs encounters this file and if the file matches the `outfile` then the plugin will render a Swagger UI in place of whatever file may already be in place. In other words, the contents of the file are completed ignored, and replaced by the output of this plugin. 

```yaml
plugins:
  - swagger-ui:
      outfile: api/quick-reference.md
pages:
  - 'Home': index.md
  - 'Quick Reference': api/quick-reference.md
```

## See Also

More information about templates [here][mkdocs-template].

More information about blocks [here][mkdocs-block].

[mkdocs-plugins]: https://www.mkdocs.org/user-guide/plugins/
[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks