Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs or Create New Examples for Release #287

Open
7 tasks
asampat3090 opened this issue Feb 16, 2019 · 0 comments
Open
7 tasks

Update Docs or Create New Examples for Release #287

asampat3090 opened this issue Feb 16, 2019 · 0 comments
Labels
docs example if requesting to create a new example of usage low-priority

Comments

@asampat3090
Copy link
Member

asampat3090 commented Feb 16, 2019

PyPi and Semver documentation

  • change README.md to match website
  • add CHANGELOG or HISTORY document for public releases
  • set versioning conventions and document and add to Developer Notes / Tools
  • instructions for a release in the Developer Notes / Tools section

Add in logger to the Readme Docs to explain how to track config and stats during runs

  • example usage,
from datmo.logger import Logger

datmo_logger = Logger()
config = {'a': 1}
datmo_logger.log_config(config)
# Perform analysis to get results

result = {'a': 1}
datmo_logger.log_result(result)
  • add a code / CLI example for run and rerun in repo + link them and explain in Readme docs
  • create hello world example with code snippet and link to Readme Docs
from sklearn import datasets
from sklearn.linear_model import LogisticRegression
from sklearn.model_selection import train_test_split

############# SAVING MY CONFIGURATIONS #############
config = { "solver": "newton-cg" } # extra line
# LOGGER CODE

############# SAVING MY MODEL ######################
iris_dataset = datasets.load_iris()
X, y = iris_dataset.data, iris_dataset.target
X_train, X_test, y_train, y_test = train_test_split(X, y)
model = LogisticRegression(**config).fit(X_train, y_train)
# SAVE MODEL TO FILE

############# SAVING MY STATISTICS/METRICS #########
train_acc = model.score(X_train, y_train)
test_acc = model.score(X_test, y_test)
# LOGGER CODE
print("train_accuracy: %s") % train_acc
print("test_accuracy: %s") % test_acc

############# CHECKING MY NEW ENVIRONMENT ##########
import catboost
print catboost.__version__
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs example if requesting to create a new example of usage low-priority
Projects
None yet
Development

No branches or pull requests

1 participant