No project description provided
Project description
TakeBlipScore
Gabriel Salgado, Juliana Guamá, Milo Utsch, Moisés Mendes e Rogers Damas
Overview
Here is presented these content:
Intro
This project proposes to offer a rate named Blip Score and represents a general metric for bot.
The proposal uses the satisfaction rate and resolution rate as input to create the BLiP Score rate. The value of the rate is in interval (0, 1) and it is better as near to 1 (one)
Blip Score Pipeline
This pipeline follows these steps:
- receive satisfaction rate and resolution rate
- fill zero if one of the rates was not calculated
- calculate Blip Score rate
~As long as we progress on this project, this description will include more details.
This project is a POC (Proof of Concept)
Configure
Here are shown recommended practices to configure project on local.
Virtual environment
This step can be done with commands or on PyCharm.
On commands
It is recommended to use virtual environment. To Create a virtual environment:
python -m venv venv
Enter to virtual environment (Windows):
./venv/Scripts/activate
Enter to virtual environment (Linux):
./venv/bin/activate
To exit virtual environment:
deactivate
On PyCharm
Open File/Settings...
or press Ctrl+Alt+S
.
This opens settings window.
Open Project: BlipScoreRate/Project Interpreter
on left menu.
Open Project Interpreter
combobox and click on Show All...
.
This opens a window with Python interpreters.
Click on +
or press Alt+Insert
.
This opens a window to create a new Python interpreter.
We will choose default options that create a new virtual environment into project.
Click on Ok
button.
Click on Ok
button again.
And again.
Configuring on PyCharm
If you are using PyCharm its better show PyCharm where is source code on project.
Right click on src
folder in Project
window at left side.
This opens context menu.
Choose Mark Directory as/Sources Root
option.
This marks src
as source root directory.
It will appears as blue folder on Project
navigator.
Install
The take_blipscore
package can be installed from PyPI:
pip install take_blipscore
Or from setup.py
, located at src
folder:
cd src
pip install . -U
cd ..
Installing take_blipscore
also installs all required libraries.
But we can intended to only install dependencies or maybe update our environment if requirements changed.
All dependencies are declared in src/requirements.txt
.
Install dependencies can be done on command or on PyCharm.
On command
To install dependencies on environment, run:
python commands.py install
On PyCharm
After you created virtual environment or on open PyCharm, it will ask if you want to install requirements.
Choose Install
.
Test
You can test on commands or on PyCharm. It is being build.
On commands
First enter to virtual environment. Then run kedro tests:
python commands.py test
When this feature is built:
See coverage results at htmlcov/index.html
.
On PyCharm
Click on Edit Configurations...
beside Run
icon.
This opens Run/Debug Configurations window.
Click on +
or press Alt+Insert
.
Choose Python tests/pytest
option.
Fill Target
field with path to tests folder as <path to project>/src/tests
.
Click on Ok
button.
Click on Run
icon.
This run the tests.
Open Terminal
window and run command to generate HTML report:
coverage html
See coverage results at htmlcov/index.html
.
Package
First enter to virtual environment.
To package this project into .egg
and .whell
:
python commands.py package
Generated packages will be in folder src/dist
.
Each new package, do not forget to increase version at src/take_blipscore/__init__.py
Upload
To upload build package to PyPI:
python commands.py upload
This upload the latest build version. After, package can be downloaded and installed by pip in any place with python and pip:
pip install take_blipscore
Notebooks
Packaging this project is intended to be installed on a specific Databricks cluster.
This is the cluster where we work with ML experiments using mlflow
.
And an experiment is done as example notebooks on shared
, that is like:
import mlflow as ml
import take_blipscore as tr
with ml.start_run():
# experiment code using our pipelines
params = {}
ml.log_params(params)
# other logs from results
Tips
In order to maintain the project:
- Do not remove or change any lines from the
.gitignore
unless you know what are you doing. - When developing experiments and production, follow data standard related to suitable layers.
- When developing experiments, put them into notebooks, following code policies.
- Write notebooks on Databricks and synchronize it to this repository into particular sub-folder in folder
notebooks
and commit them. - Do not commit any data.
- Do not commit any log file.
- Do not commit any credentials or local configuration.
- Keep all credentials or local configuration in folder
conf/local/
. - Do not commit any generated file on testing or building processes.
- Run test before pull request to make sure that has no bug.
- Follow git flow practices:
- Create feature branch for new feature from
dev
branch. Work on this branch with commits and pushes. Send a pull request todev
branch when terminate the work. - When terminate a set of features to release, merge
dev
branch totest
branch. Apply several and strict tests to be sure that all are fine. On find errors, fix all and apply tests again. When all are ok, merge fromtest
tomaster
increasing release version and uploading to PyPI. - If some bug is found on production,
master
branch, create hotfix branch frommaster
. Correct all errors and apply tests like intest
branch. When all are ok, merge from hotfix branch tomaster
and then, merge frommaster
todev
.
- Create feature branch for new feature from
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for take_blipscore-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05bc97e1c7ccc1c793e5c48e69f15b397b2f2ef15b442d41c4ef7a16a0a3b02d |
|
MD5 | ca60411e69d267c4797f3c030d8e9f27 |
|
BLAKE2b-256 | 253316b9987eae9778cecb88302231f281d1b4cb4d0b4ed11058e430bf2e4f0e |