Skip to content
This repository was archived by the owner on May 9, 2023. It is now read-only.

Conversation

@enze-chen
Copy link
Contributor

@enze-chen enze-chen commented Jul 15, 2019

Content updates are as follows:

  • Added client.data.delete_dataset() method.
  • Added a couple more examples to SearchClient tutorial.
  • Added a SL demo notebook using a steel fatigue dataset.

Also cleaned up the code to have better readability and flow based on iterative feedback and improvements from the past several months.

@enze-chen enze-chen requested a review from maxhutch July 15, 2019 19:25
@maxhutch
Copy link
Contributor

The diff here is extensive. Could you comment on the line changes that are more than stylistic touch-ups?

@enze-chen
Copy link
Contributor Author

enze-chen commented Jul 15, 2019

@maxhutch Hmm, 1) Perhaps I used the wrong language, and 2) Perhaps it's a little intimidating, but I actually do think the changes leading to the massive diff, besides the three points I named, are stylistic in nature. I can certainly comment on what those are:

  • More direct import of Python packages, e.g. from time import sleep instead of import time
  • Specifying the input keys and arguments for functions on newlines, e.g.
CitrinationClient(api_key=key, 
                  site=site)

instead of CitrinationClient(key, site).

  • More consistent formatting on code snippets in Markdown blocks, with inline backticks instead of bold.
  • Adding some descriptive texts around naked code blocks, particularly when they appear consecutively.
  • Consistent language / names.
  • Displaying more URLs to show how API corresponds to the web interface.
  • Removed redundant, dead code. Reworded awkward parts.
  • Simplified docstrings and made them more consistent.

"metadata": {},
"outputs": [],
"source": [
"# data_client.delete_dataset(dataset_id=dataset_id)"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a block for client.data.delete_dataset(). It's commented out so someone doesn't accidentally do this.

"cell_type": "markdown",
"metadata": {},
"source": [
"### Example: Filter a range of values\n",
Copy link
Contributor Author

@enze-chen enze-chen Jul 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added an example to create a Filter with min and max

"cell_type": "markdown",
"metadata": {},
"source": [
"### Example: Logic\n",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added an example with a Filter with logic.

"source": [
"<div class = \"intro\">\n",
"\n",
"# Sequential Learning Workshop\n",
Copy link
Contributor Author

@enze-chen enze-chen Jul 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This SL notebook uses a steel fatigue dataset instead of a toy function/data.

@@ -0,0 +1,706 @@
'''
Authors: Eddie Kim, Enze Chen, Nils Persson
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the corresponding wrapper for the steel fatigue SL demo.

@enze-chen
Copy link
Contributor Author

@maxhutch Added comments where the changes actually took place. Thanks. :)

Copy link
Contributor

@maxhutch maxhutch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look fine, but there is some weird formatting in the github render of:
https://github.com/CitrineInformatics/learn-citrination/blob/update-api-tutorials/citrination_api_examples/clients_sequence/6_sequential_learning_steel_fatigue.ipynb

Do you know what's going on there?

@enze-chen
Copy link
Contributor Author

Do you know what's going on there?

Wow; good catch! That's some leftover HTML formatting that's hidden when the Markdown renders in Jupyter, but apparently not on GitHub! :O I removed all of it—I think.

@enze-chen
Copy link
Contributor Author

Hmm....it looks like there's a library dependency on ase that suddenly requires Python 3.5+. It's when we try to import dfttopif. How should we proceed @maxhutch? Remove Python 2.7 from the support as well?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants