Metadata-Version: 2.1
Name: ldm-python-client-lib
Version: 0.0.8
Summary: Python client side functions for working with LDM framework.
Home-page: https://github.com/IMCS-DL4media/LDM_midterm
Author: sergejsrk
Author-email: rikachovs@gmail.com
License: MIT
Download-URL: https://pypi.org/project/ldm_python_client_lib/
Keywords: LDM,Python 3,ML life cycle
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: requests

# LDMLogger

## Class LDMLogger contains methods for working with LDM framework.

## Methods:

### def __init__(self, user_token, project_id=None, server_url="http://localhost:5000", root_dir=Path(os.getcwd()).parent, should_upload_sources = False)
    Creates new instance of class LDMLogger


### def start_run(self, comment = "", git_commit_url = "" ):
    Starts a new run
### def log(self, body):
    Logs message msg to server.
### def finish_run(self):
    Finish the current run.
### def validate(self, results, dataset_type="Train"):
    Validate on dataset.
### def upload_file(self, file_name, comment = ""):
    Uploads file (file_name) to the logging server and attaches it to the current run.
### def add_project(self, name, project_type, description=""):
    Adding project.
### def upload_dataset(self, path_to_dataset,dataset_type_in="Train"):
    Uploads dataset to server.
### def upload_sources(self):
    Creates a .zip of root_dir and uploads it to the LDM server.
### def download_dataset(self, path="", dataset_type_in="Train"):
    Downloads dataset from server.
### def save_colab_notebook_history_to_file(self, file_name):
    Creates new notebook containing history of all executed cells of the current notebook.





# Change log


## [0.0.1] - 2020-12-09
## [0.0.3] - 2021-02-10
## [0.0.4] - 2021-02-12



### Added
- Functions for 
	- dataset upload 
	- dataset download
	- project creation
	- result validation on a specific dataset

### Changed
- changed package structure (only one package (logger) is uploaded)
- removed all examples from package logger
- class LDMLogger has package visibility


### Removed

## [0.0.6] - 2021-02-17
### Changed
- start_run does not upload sources by default

## [0.0.7] - 2021-03-19
### Added
- Function to save notebook

## [0.0.8] - 2021-03-20
### Removed
- `N/A`
### Changed
- Updated readme and docs
### Added
- `N/A`



