BXMSODC-2980-master: PMML doc for DM/PAM 7.1 #1103

sterobin · 2018-09-21T19:20:47Z

Ready for upstream master.

See JIRA for details.

lanceleverich · 2018-09-24T14:01:59Z

Approved

lanceleverich

Looks good to me.

emmurphy1 · 2018-09-24T14:25:13Z

doc-content/drools-docs/src/main/asciidoc/DMN/dmn-con.adoc

@@ -1,6 +1,6 @@
 [id='dmn-con_{context}']
-= Decision model and notation
+= Decision Model and Notation (DMN)


OK, I think we've discussed this before. I don't define acronyms or initialisms in headings or titles. I think it's in the IBM SG but I can't find it off hand. I think Ingrid found once. I assume you are doing it here because DMN is more widely understood than the spelled out version?

IBM SG p. 7. Can use either just the full, the full plus abb in parens, or just the abb so long is it is spelled out in first mention in the text that follows. Also states that on first mention, optimal to provide both the full and abb form, as I've done here. The notion of first mention is quite hazy in mod docs, as we've discussed, so what I do is do this treatment in high-level concepts but not in low-level cons, procs, or refs.

emmurphy1 · 2018-09-24T14:25:38Z

doc-content/drools-docs/src/main/asciidoc/DMN/dmn-con.adoc


-Decision Model and Notation (DMN) is a standard established by the Object Management Group (OMG) for describing and modeling operational decisions. DMN decision models can be shared between platforms and across organizations so that business analysts and business rules developers are unified in designing and implementing DMN decision services. The DMN standard is similar to and can be used together with the Business Process Model and Notation (BPMN) standard for designing and modeling business processes.
+Decision Model and Notation (DMN) is a standard established by the Object Management Group (OMG) for describing and modeling operational decisions. DMN decision models can be shared between DMN-compliant platforms and across organizations so that business analysts and business rules developers are unified in designing and implementing DMN decision services. The DMN standard is similar to and can be used together with the Business Process Model and Notation (BPMN) standard for designing and modeling business processes.


If you define in the title, I don't think you should define here.

Right, but I just prefer to.

emmurphy1 · 2018-09-24T14:26:24Z

doc-content/drools-docs/src/main/asciidoc/DMN/dmn-con.adoc


-Decision Model and Notation (DMN) is a standard established by the Object Management Group (OMG) for describing and modeling operational decisions. DMN decision models can be shared between platforms and across organizations so that business analysts and business rules developers are unified in designing and implementing DMN decision services. The DMN standard is similar to and can be used together with the Business Process Model and Notation (BPMN) standard for designing and modeling business processes.
+Decision Model and Notation (DMN) is a standard established by the Object Management Group (OMG) for describing and modeling operational decisions. DMN decision models can be shared between DMN-compliant platforms and across organizations so that business analysts and business rules developers are unified in designing and implementing DMN decision services. The DMN standard is similar to and can be used together with the Business Process Model and Notation (BPMN) standard for designing and modeling business processes.


It together with redundant?

Great point! They do both mean the same thing but feels like "together with" just emphasizes the co-operation of the two. I'll think on it.

emmurphy1 · 2018-09-24T14:36:38Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-conformance-con.adoc

-The PMML specification allows for http://dmg.org/pmml/v4-2-1/GeneralStructure.html#xsdElement_Extension[Extension] elements at almost every level of the model definition.
-In order to facilitate some functionality, {context} has a few pre-defined extensions.
+Consumer conformance::
+An application is consumer conforming if it accepts valid PMML documents for at least one type of model. Satisfying consumer conformance requirements ensures that a PMML model created according to producer conformance can be integrated and used as defined. For example, if an application is consumer conforming for Regression model types, then valid PMML documents defining models of this type produced by different conforming producers would be interchangeable in the application.


I think 'would be' should be 'are'. If you have a good argument why should be is correct, I'd like to hear it :-).

You and I have discussed this before. You are 100% correct that per IBM and common tech writing practice, we should avoid too much conditional info (would, should, could). Hypothetical examples become hazy because syntactically, it should be "would", for the same reason why subjunctive is used with hypotheticals (if I were you vs. if I was you). So it needs to be one of those deliberate breaking of the "rule" for the sake of optimal global English considerations for a mass audience. But one needs to know the rules to effectively break them :)

The key test is if replacing the "correct" conditional usage (would be) with the "incorrect" but clearer indicative usage (are) is in fact better or at least isn't worse. I think in this case it does read funny, to me, with "are".

emmurphy1 · 2018-09-24T14:37:34Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-extensions-ref.adoc

+[id='pmml-extensions-ref_{context}']
+= PMML extensions in {PRODUCT}
+
+The PMML specification supports `Extension` elements that extend the content of a PMML model. You can use extensions at almost every level of a PMML model definition, and as the first and last child in the main element of a model for maximum flexibility. For more information about PMML extensions, see the DMG PMML http://dmg.org/pmml/v4-2-1/GeneralStructure.html#xsdElement_Extension[Extension Mechanism].


Just double-check that Extensions should be capped.

'tis. Thanks.

emmurphy1 · 2018-09-24T14:46:10Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-invocation-embedded-proc.adoc

+    ...
+}
+----
+<1> Used when the model type is `MiningModel`. The `segmentationId` is used to differentiate between multiple segmentations.


So my understanding of punctuation with lists is that if any list item contains a complete sentence than every list item gets a period. Am I wrong?

You are correct! Oops. Thanks!

emmurphy1 · 2018-09-24T14:48:09Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-invocation-embedded-proc.adoc

+    ...
+}
+----
+<1> Note that the class is parameterized so that it can handle many different types


This item needs a period, right? And if I am correct in my previous comment, so do the rest of the items.

Yep! Reworded to make incomplete for consistency.

emmurphy1 · 2018-09-24T14:48:53Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-invocation-embedded-proc.adoc

+}
+----
+
+NOTE: In this example, the `calculatePossiblePackageNames` method and the `getStartingRuleUnit` method are assumed to belong to the same class as the `executeModel` method.


[NOTE]? Search this PF for other instances.

emmurphy1 · 2018-09-24T14:53:48Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-invocation-helper-classes-ref.adoc

+public static PMML4ExecutionHelper getExecutionHelper(String modelName, Resource resource, KieBaseConfiguration kieBaseConf, boolean includeMiningDataSources)
+----
+
+NOTE: The classpath, byte array, and resource `PMML4ExecutionHelperFactory` methods create a KIE container for the generated rules and Java classes. The container is used as the source of the KIE base that the `RuleUnitExecutor` uses. The container does not get persisted. The `PMML4ExecutionHelperFactory` method for PMML assets that are already in a KIE base does not create a KIE container in this way.


'does not get persisted'? Is this OK? Is not persisted?

Yes, much better.

emmurphy1 · 2018-09-24T14:56:50Z

doc-content/drools-docs/src/main/asciidoc/PMML/pmml-support-con.adoc

+{PRODUCT} does not include a built-in PMML model editor, but you can use an XML or PMML-specific authoring tool to create PMML models and then integrate the PMML models in your decision services in {PRODUCT}. You can import PMML files into your project in {CENTRAL} (*Menu -> Design -> Projects -> Import Asset*) or package the PMML files as part of your project knowledge JAR (KJAR) file without {CENTRAL}.
+
+When you add a PMML file to a project in {PRODUCT}, multiple assets are generated. Each type of PMML model generates a different set of
+assets, but all PMML model types generate at least the following set of assets:


soft line break.

Thanks. These are common in single-sourced content that is created first by devs because they use IntelliJ as their text editor and the content gets formatted with a lot of soft breaks in Atom. I can usually address 99% of them, but a couple always slip through. Annoying!

sterobin · 2018-09-24T18:56:13Z

Jenkins retest this please

sterobin · 2018-09-24T20:00:56Z

ok to test

sterobin · 2018-09-25T13:04:40Z

ok to test

…feedback.

…feedback. (apache#1103)

…feedback. (#1103)

sterobin changed the title ~~BXMSODC-2980-master: Created PMML doc for DM/PAM 7.1~~ WIP: BXMSODC-2980-master: Created PMML doc for DM/PAM 7.1 Sep 21, 2018

sterobin requested a review from lanceleverich September 21, 2018 19:21

sterobin changed the title ~~WIP: BXMSODC-2980-master: Created PMML doc for DM/PAM 7.1~~ WIP: BXMSODC-2980-master: PMML doc for DM/PAM 7.1 Sep 21, 2018

sterobin force-pushed the BXMSDOC-2980-master branch from c6c3eec to 4e89a27 Compare September 21, 2018 21:29

sterobin requested a review from baldimir September 22, 2018 00:49

lanceleverich approved these changes Sep 24, 2018

View reviewed changes

emmurphy1 reviewed Sep 24, 2018

View reviewed changes

sterobin force-pushed the BXMSDOC-2980-master branch from 39b9bf9 to 77c5d3d Compare September 24, 2018 18:03

sterobin changed the title ~~WIP: BXMSODC-2980-master: PMML doc for DM/PAM 7.1~~ BXMSODC-2980-master: PMML doc for DM/PAM 7.1 Sep 24, 2018

sterobin removed the request for review from baldimir September 24, 2018 18:07

sterobin force-pushed the BXMSDOC-2980-master branch from c5dd6de to 41fc11f Compare September 24, 2018 21:06

sterobin requested a review from baldimir September 25, 2018 01:30

sterobin changed the title ~~BXMSODC-2980-master: PMML doc for DM/PAM 7.1~~ WIP: BXMSODC-2980-master: PMML doc for DM/PAM 7.1 Sep 25, 2018

BXMSODC-2980-master: Create PMML doc and implement SME, QE, and peer …

f84386e

…feedback.

sterobin force-pushed the BXMSDOC-2980-master branch from 9c360bc to f84386e Compare September 25, 2018 15:36

sterobin changed the title ~~WIP: BXMSODC-2980-master: PMML doc for DM/PAM 7.1~~ BXMSODC-2980-master: PMML doc for DM/PAM 7.1 Sep 25, 2018

sterobin merged commit afe4699 into apache:master Sep 25, 2018

sterobin deleted the BXMSDOC-2980-master branch November 12, 2019 17:34

tkobayas pushed a commit to tkobayas/kie-docs that referenced this pull request May 7, 2025

BXMSODC-2980-master: Create PMML doc and implement SME, QE, and peer …

b82dc66

…feedback. (apache#1103)

tkobayas pushed a commit to tkobayas/kie-docs that referenced this pull request May 8, 2025

BXMSODC-2980-master: Create PMML doc and implement SME, QE, and peer …

384ea5f

…feedback. (apache#1103)

tkobayas pushed a commit to tkobayas/kie-docs that referenced this pull request May 8, 2025

BXMSODC-2980-master: Create PMML doc and implement SME, QE, and peer …

df22b73

…feedback. (apache#1103)

tkobayas pushed a commit to tkobayas/kie-docs that referenced this pull request May 8, 2025

BXMSODC-2980-master: Create PMML doc and implement SME, QE, and peer …

4532ec8

…feedback. (apache#1103)

tkobayas pushed a commit that referenced this pull request May 8, 2025

BXMSODC-2980-master: Create PMML doc and implement SME, QE, and peer …

81ddf52

…feedback. (#1103)


		Decision Model and Notation (DMN) is a standard established by the Object Management Group (OMG) for describing and modeling operational decisions. DMN decision models can be shared between platforms and across organizations so that business analysts and business rules developers are unified in designing and implementing DMN decision services. The DMN standard is similar to and can be used together with the Business Process Model and Notation (BPMN) standard for designing and modeling business processes.
		Decision Model and Notation (DMN) is a standard established by the Object Management Group (OMG) for describing and modeling operational decisions. DMN decision models can be shared between DMN-compliant platforms and across organizations so that business analysts and business rules developers are unified in designing and implementing DMN decision services. The DMN standard is similar to and can be used together with the Business Process Model and Notation (BPMN) standard for designing and modeling business processes.

BXMSODC-2980-master: PMML doc for DM/PAM 7.1 #1103

BXMSODC-2980-master: PMML doc for DM/PAM 7.1 #1103

Uh oh!

Conversation

sterobin commented Sep 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lanceleverich commented Sep 24, 2018

Uh oh!

lanceleverich left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sterobin commented Sep 24, 2018

Uh oh!

sterobin commented Sep 24, 2018

Uh oh!

sterobin commented Sep 25, 2018

Uh oh!

Uh oh!

sterobin commented Sep 21, 2018 •

edited

Loading