Repository: mahout Updated Branches: refs/heads/master d5072a082 -> be2ad1c75
WEBSITE Spelling and grammer in Contrib Tutorial Project: http://git-wip-us.apache.org/repos/asf/mahout/repo Commit: http://git-wip-us.apache.org/repos/asf/mahout/commit/be2ad1c7 Tree: http://git-wip-us.apache.org/repos/asf/mahout/tree/be2ad1c7 Diff: http://git-wip-us.apache.org/repos/asf/mahout/diff/be2ad1c7 Branch: refs/heads/master Commit: be2ad1c75b756ca7a797596ab70356308360a509 Parents: d5072a0 Author: rawkintrevo <[email protected]> Authored: Sun May 7 18:32:08 2017 -0500 Committer: rawkintrevo <[email protected]> Committed: Sun May 7 18:32:08 2017 -0500 ---------------------------------------------------------------------- .../tutorials/misc/contributing-algos/index.md | 30 ++++++++++++++++++++ 1 file changed, 30 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mahout/blob/be2ad1c7/website/docs/tutorials/misc/contributing-algos/index.md ---------------------------------------------------------------------- diff --git a/website/docs/tutorials/misc/contributing-algos/index.md b/website/docs/tutorials/misc/contributing-algos/index.md index bc5aece..48388d7 100644 --- a/website/docs/tutorials/misc/contributing-algos/index.md +++ b/website/docs/tutorials/misc/contributing-algos/index.md @@ -7,6 +7,7 @@ theme: The Mahout community is driven by user contribution. If you have implemented an algorithm and are interested in sharing it with the rest of the community, we highly encourage you to contribute it to the codebase. However to +<<<<<<< HEAD keep things from getting too out of control, we has instituted a standard API for our algorithms, and we ask you contribute your algorithm in a way that conforms to this API as much as possible. You can always reach out on [[email protected]]([email protected]). @@ -16,6 +17,16 @@ contribute your algorithm in a way that conforms to this API as much as possible In this example, let's say you've created a totally new algorithm- a regression algorithm called `Foo` The `Foo` algorithm is a silly algorithm- it always guesses the target is 1. +======= +keep things from getting too out of control, we have instituted a standard API for our algorithms, and we ask you +contribute your algorithm in a way that conforms to this API as much as possible. You can always reach out on +[[email protected]]([email protected]) if you need help. + +In this example, let's say you've created a totally new algorithm- a regression algorithm called `Foo` + +The `Foo` algorithm is a silly algorithm- it always guesses the target is 1. Not at all useful as an algorithm, but great for +illustrating how an algorithm would be added. +>>>>>>> 2b0ee5f7d3f2c262d4c34d725c8fa570d530e3cb ## Step 1: Create JIRA ticket @@ -108,8 +119,15 @@ In your algorithm, most of your code is going to go into the `.fit` method. Sinc /** * Normally one would have a lot more code here. */ +<<<<<<< HEAD new FooModel model.summary = "This model has been fit, I would tell you more interesting things- if there was anything to tell." +======= + + var model = new FooModel[K] + model.summary = "This model has been fit, I would tell you more interesting things- if there was anything to tell." + model +>>>>>>> 2b0ee5f7d3f2c262d4c34d725c8fa570d530e3cb } } @@ -125,7 +143,11 @@ In your algorithm, most of your code is going to go into the `.fit` method. Sinc } } +<<<<<<< HEAD I've also added something to the Summary thing. It wasn't a very helpful thing, but this isn't a very helpful algorithm. I included +======= +I've also added something to the summary string. It wasn't a very helpful thing, but this isn't a very helpful algorithm. I included +>>>>>>> 2b0ee5f7d3f2c262d4c34d725c8fa570d530e3cb as a reminder to you, the person writing a useful algorithm, that this is a good place to talk about the results of the fitting. At this point it would be reasonable to try building Mahout and checking that your algorithm is working the way you expect it to @@ -160,7 +182,11 @@ And everything seems to be in order. ## Step 4. Working with Hyper Parameters +<<<<<<< HEAD It's entirely likely you'll need to have hyper-parameters to tune you algorithm. +======= +It's entirely likely you'll need to have hyper-parameters to tune your algorithm. +>>>>>>> 2b0ee5f7d3f2c262d4c34d725c8fa570d530e3cb In Mahout we handle these with a map of Symbols. You might have noticed in the `fit` and `predict` methods we included `hyperparameters: (Symbol, Any)*` @@ -404,7 +430,11 @@ There is a "branch" drop down menu- scroll down and find `mahout-xxxx`  +<<<<<<< HEAD Towards the top, off to the right, you'll see a link to "Create PR", click on this- and follow the prompts! +======= +Towards the top, off to the right, you'll see a link to "Pull Request", click on this- and follow the prompts! +>>>>>>> 2b0ee5f7d3f2c262d4c34d725c8fa570d530e3cb 
